DESC/docs at master · PlasmaControl/DESC · GitHub

Name		Name	Last commit message	Last commit date
parent directory ..
_static		_static
_templates		_templates
dev_guide		dev_guide
dev_notes		dev_notes
notebooks		notebooks
Dudt_Kolemen_PoP_2020.pdf		Dudt_Kolemen_PoP_2020.pdf
Makefile		Makefile
README.rst		README.rst
api.rst		api.rst
api_continuation.rst		api_continuation.rst
api_equilibrium.rst		api_equilibrium.rst
api_fields.rst		api_fields.rst
api_io.rst		api_io.rst
api_objectives.rst		api_objectives.rst
api_particles.rst		api_particles.rst
api_plotting.rst		api_plotting.rst
binary_output_format.rst		binary_output_format.rst
command_line.rst		command_line.rst
conf.py		conf.py
index.rst		index.rst
input.rst		input.rst
installation.rst		installation.rst
make.bat		make.bat
optimizers.rst		optimizers.rst
output.rst		output.rst
performance_tips.rst		performance_tips.rst
pubs_list.rst		pubs_list.rst
sort_compute_funs.py		sort_compute_funs.py
text_output_format.rst		text_output_format.rst
theory_general.rst		theory_general.rst
write_optimizers.py		write_optimizers.py
write_variables.py		write_variables.py

README.rst

To build the documentation locally, install the developer requirements and run from the DESC directory:

cd docs
conda install -c conda-forge pandoc
make html

will build the documentation in the _build/html/ folder of the docs folder.

To build the pdf, type make latexpdf from the docs/ directory.