... | @@ -2,11 +2,25 @@ These are general notes on the styling of the project and things we need to be c |
... | @@ -2,11 +2,25 @@ These are general notes on the styling of the project and things we need to be c |
|
|
|
|
|
Make sure to install sphinx and sphinx-rtd-theme first:
|
|
Make sure to install sphinx and sphinx-rtd-theme first:
|
|
|
|
|
|
```
|
|
```console
|
|
pip install sphinx
|
|
pip install sphinx
|
|
pip install sphinx-rtd-theme
|
|
pip install sphinx-rtd-theme
|
|
```
|
|
```
|
|
|
|
|
|
|
|
To build the documentation make sure to first run pytest as this will generate the imgs in the tmp folder for sphinx.
|
|
|
|
|
|
|
|
```console
|
|
|
|
pytest --doctest-modules ketos/
|
|
|
|
```
|
|
|
|
|
|
|
|
Then, from the docs folder run `make html`
|
|
|
|
|
|
|
|
```console
|
|
|
|
cd docs/
|
|
|
|
make html
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
1. We are using the Read the docs (rtd - https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html) styling for sphinx. I have altered a little bit of the layout.html of the original rtd theme to allow for 2 logos to be inserted as well as to allow for a link to the meridian website. You can find this layout in the _templates folder.
|
|
1. We are using the Read the docs (rtd - https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html) styling for sphinx. I have altered a little bit of the layout.html of the original rtd theme to allow for 2 logos to be inserted as well as to allow for a link to the meridian website. You can find this layout in the _templates folder.
|
|
|
|
|
|
|
|
|
... | | ... | |