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

Documentation theme #8

Open

mateusoliveira43 opened this issue Sep 5, 2022 · 3 comments

Owner

mateusoliveira43 commented Sep 5, 2022

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

Owner Author

mateusoliveira43 commented Sep 6, 2022

this link can be useful

Owner Author

mateusoliveira43 commented Sep 6, 2022

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

Owner Author

mateusoliveira43 commented Oct 21, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment