wwfxuk / tk-katana

Shotgun Engine for Katana
https://wwfxuk.github.io/tk-katana/
Other
3 stars 2 forks source link

How to generate documentation #9

Closed j0yu closed 5 years ago

j0yu commented 5 years ago

Is your feature request related to a problem? Please describe. Write up on how to generate the documentation and when developing, forcing the CI to generate pages

Describe the solution you'd like New howto/makedocs.rst outlining setting up venv and modifying .travis.yml (and why generally it is not a good idea)

Additional context

rm -rf ./docs/api/ ./docs/_build/
source /path/to/docs/venv/bin/activate
sphinx-apidoc -o ./docs/api --separate --no-toc ./
sphinx-apidoc -o ./docs/api/hooks --separate --tocfile index ./hooks
sphinx-build ./docs ./docs/_build