search

mateusoliveira43 / python-project-template

Template for a Python project | Modelo de projeto Python
https://github.com/mateusoliveira43/python-project-template/wiki
MIT License
7 stars 0 forks source link

Documentation theme #8

Open mateusoliveira43 opened 2 years ago

mateusoliveira43 commented 2 years ago

Use a theme that has dark mode, like in here.

mateusoliveira43 commented 2 years ago

this link can be useful

mateusoliveira43 commented 2 years ago

options using sphinx. mkdocs can be another option. Using read the docs seems the best option

mateusoliveira43 commented 2 years ago

Use mkdocs (with mkdocstrings), hosted in read the docs with material theme.

Examples: https://github.com/dynaconf/dynaconf, https://github.com/tiangolo/fastapi (put every thing under docs folder, like in FastAPI) and https://github.com/konveyor/pelorus