Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(docs): setup automatic documentation #18

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

chore(docs): setup automatic documentation #18

wants to merge 2 commits into from

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 mentioned this pull request Sep 22, 2021
Open
@UrbanoFonseca UrbanoFonseca linked an issue Sep 22, 2021 that may be closed by this pull request
docs: enable automatic documentation #35
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@UrbanoFonseca UrbanoFonseca

Labels
documentation Documentation only changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: enable automatic documentation
1 participant
@UrbanoFonseca