Getting Started with Documentation¶
Compiling Documentation Locally¶
This example is a step-by-step guide on how to compile the tudat-space documentation
locally on your system using
This procedure requires that Anaconda or Miniconda is installed. For information regarding the use of the conda ecosystem, please see Getting Started with Conda.
Create an environment that will be satisfy all dependencies required for building documentation, then activate it.
conda create -y --name tudat-docs python=3.7 & conda activate tudat-docs
Install all dependencies for building the documentation. The
-yflag instructs the
conda-installcommand to install packages without asking for confirmation.
:: Windows systems conda install sphinx -y & ^ conda install sphinx_rtd_theme -y & ^ conda install sphinx-tabs -y & ^ conda install sphinx-copybutton -y & ^ pip install rtcat_sphinx_theme & ^ pip install sphinxcontrib-contentui
# Unix systems (Mac & Linux) conda install sphinx -y & \ conda install sphinx_rtd_theme -y & \ conda install sphinx-tabs -y & \ conda install sphinx-copybutton -y & \ pip install rtcat_sphinx_theme & \ pip install sphinxcontrib-contentui
Enter the root directory of a repository containing a
docsdirectory, which contains a
sourcesubdirectory. The following command is specific to cloning and entering the
git clone https://github.com/tudat-team/tudat-space.git & cd tudat-space
Build the documentation using the
sphinx-buildcommand, specifying that html is to be built with the supplied source and output build directory.
sphinx-build -b html docs/source docs/build
View the local build of the documentation by opening the
docs/build/index.htmlwith your preferred browser.
[PyCharm/CLion] You can do this in by right clicking
index.html in the Project tree and selecting
Open with Browser.