|
|
The Python API docs are generated from the source code using [Sphinx](https://www.sphinx-doc.org/en/master/).
|
|
|
|
|
|
They are currently not hosted anywhere and must be built locally. The following section will outline the build process. Python 3.8+, pip, and git are required.
|
|
|
|
|
|
## Building the documentation
|
|
|
|
|
|
1. Clone the BASEmesh repository:
|
|
|
|
|
|
```sh
|
|
|
git clone https://gitlab.ethz.ch/vaw/public/basemesh-v2
|
|
|
```
|
|
|
|
|
|
2. Install the dependencies required to build the documentation:
|
|
|
|
|
|
```sh
|
|
|
python -m pip install --user -r docs/requirements.txt
|
|
|
```
|
|
|
|
|
|
3. Switch to the Sphinx documentation subproject:
|
|
|
|
|
|
```sh
|
|
|
cd docs/
|
|
|
```
|
|
|
|
|
|
4. Run Sphinx and build the docs:
|
|
|
|
|
|
```sh
|
|
|
python -m sphinx.cmd.build -b html . _build
|
|
|
```
|
|
|
|
|
|
The generated documentation files will now reside in `docs/_build/index.html` and can be viewed in any web browser. |