Open miczyg1 opened 1 year ago
Currently the documentation is generated from docstrings to Sphinx. mkdocs have equivalent extension. https://mkdocs.readthedocs.io/en/restructure-compat/user-guide/styling-your-docs/
Sticking with mkdocs, we only need to use one documentation framework, we can still use markdown, and we can reuse the know-how, pre-commit hooks (which are missing in this repo, BTW), etc.
https://mkdocstrings.github.io/ plugin can put Python docstrings into mkdocs as well
Such documentation should be hosted somewhere, e.g. GitHub pages.
https://github.com/Dasharo/Openness-Score/pull/5#discussion_r1211345323
miczyg1
commented
1 year ago
Currently the documentation is generated from docstrings to Sphinx. mkdocs have equivalent extension. https://mkdocs.readthedocs.io/en/restructure-compat/user-guide/styling-your-docs/
Sticking with mkdocs, we only need to use one documentation framework, we can still use markdown, and we can reuse the know-how, pre-commit hooks (which are missing in this repo, BTW), etc.
https://mkdocstrings.github.io/ plugin can put Python docstrings into mkdocs as well
Such documentation should be hosted somewhere, e.g. GitHub pages.