How to build the website locally

How to build the tudat-space website locally

1. Clone the repository and enter directory

git clone https://github.com/tudat-team/tudat-space
cd tudat-space

2. Clone the tudatpy-examples submodule

git submodule update --init --recursive

The Sphinx build process is documented in the tudat-developer-docs.

In short, the tudat-space website can be built as follows:

3. Install the tudat-docs conda environment:

conda env create -f docs/environment.yaml

4. Activate the tudat-docs environment:

conda activate tudat-docs

5. Build the website:

The local build can be triggered from the command-line or using an IDE. For IDE-specific instructions, see the tudat-developer-docs.

The website is built using the sphinx-build command, specifying html as desired output.

sphinx-build -b html docs/source docs/build

By default, this will only trigger a partial rebuild of the files with changes. This might lead to issues when changing file names or after switching branches. In that case, a full rebuild can be triggered by adding a -E flag:

sphinx-build -b html docs/source docs/build -E

For additional troubleshooting see the Troubleshooting section in the tudat-developer-docs.

6. View the local build:

You can check your local build by opening the newly created docs/build/index.html with your preferred browser and navigating as desired.