Skip to content

Conversation

@UrbanoFonseca
Copy link
Contributor

Features:

  • Automatic documentation of docstrings
  • Adhoc documentation of rst files
  • Custom CSS formatting by defining the /docs/_static/css/custom.css file

To build the documentation

pip install -e .
pip install -r requirements-dev.txt
cd docs
make clean && make html
xdg-open _build/html/index.html 

@UrbanoFonseca UrbanoFonseca added the documentation Documentation only changes label Sep 9, 2021
@UrbanoFonseca UrbanoFonseca self-assigned this Sep 9, 2021
@UrbanoFonseca UrbanoFonseca linked an issue Sep 22, 2021 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: enable automatic documentation

1 participant