datamol.io
Curious question: What python library are you using to automate documentation generation? #192
-
|
What python library are you using to automate documentation generation? Thanks. |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment 1 reply
-
|
We use mkdocs-material, part of the mkdocs ecosystem and mike for version control of the docs. Please see: https://github.com/datamol-io/datamol/blob/main/mkdocs.yml for an example configuration file and https://github.com/datamol-io/datamol/tree/main/docs for the corresponding documentation links. This file give an example of how the document link for a module should look like: https://raw.githubusercontent.com/datamol-io/datamol/main/docs/api/datamol.mol.md. This is assuming that all relevant function have proper docstrings (and optionally type hints). For release, we just need to update/add docstrings or add new documentation page, then we have a github-action: https://github.com/datamol-io/datamol/blob/main/.github/workflows/doc.yml that builds the documentation automatically on push to the main branch and release. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks! |
Beta Was this translation helpful? Give feedback.
We use mkdocs-material, part of the mkdocs ecosystem and mike for version control of the docs.
Please see: https://github.com/datamol-io/datamol/blob/main/mkdocs.yml for an example configuration file and https://github.com/datamol-io/datamol/tree/main/docs for the corresponding documentation links.
This file give an example of how the document link for a module should look like: https://raw.githubusercontent.com/datamol-io/datamol/main/docs/api/datamol.mol.md. This is assuming that all relevant function have proper docstrings (and optionally type hints).
For release, we just need to update/add docstrings or add new documentation page, then we have a github-action: https://github.com/datam…