There's no standard autodoc replacement; instead there are many which cannot be considered very mature yet. One striking difference might be that since mkdocs is markdown based, docstrings purposedly avoid using numpydoc docstrings because they resemble RST too much. I don't see this as a problem for new projects, but might be something to discuss. There are other plugins in the making that will add support for numpydoc but none robust yet.
We won't deploy to readthedocs but to github.io automatically, thanks to GH Actions.
Description
This is an attempt at using
mkdocs
+material
+mkdocstrings
work as a replacement for ReadTheDocs.URL: http://openkinome.github.io/kinoml/
Tasklist
mkdocs
branch from Docs CI eventsGotchas
autodoc
replacement; instead there are many which cannot be considered very mature yet. One striking difference might be that sincemkdocs
ismarkdown
based, docstrings purposedly avoid usingnumpydoc
docstrings because they resemble RST too much. I don't see this as a problem for new projects, but might be something to discuss. There are other plugins in the making that will add support fornumpydoc
but none robust yet.readthedocs
but togithub.io
automatically, thanks to GH Actions.