Closed kloczek closed 8 months ago
BTW .. mkdic currently is used only with handful number of modules and sphinx is de facto python modules documentation standard.
[tkloczko@pers-jacek SPECS]$ grep "# NOTE:.*mkdoc" python-*
python-httpx.spec:# NOTE: uses mkdoc
python-pdm.spec:# NOTE: uses mkdoc
python-starlette.spec:# NOTE: package uses mkdoc
python-typer.spec:# NOTE: docs/ used mkdocs
Just searched across some my notes and found https://github.com/jfhbrook/pyee/pull/141
I have no idea what you mean. Sphinx support is definitely not missing or broken. Sphinx is how we build documentation on RTD. docs/conf.py
exists in the repository and the sdist.
Sorry my mistake. I've been working on two modules and placed this ticked in your repo .. wrong repo😋
Looks like 3.0.3 has removed sphinx support. It would be really good to restore sphinx support. Reason for that is mkdoc do not support rendering roff output (AKA man page). In our distribution we are using sphinx to generate module man page as standard documentation format.
Above means that on scale 1224 packages with python modules in more than half (676) cases it is possible to generate dokumentom as man page. Each module man page is available under
python-<module_name>
name which allows easy access to any module documentation. Example from my current devel systemTo provide back sphinx support all what is necessary to do is restore docs/conf.py and trim it a bit because sphinx can process .rst files as well. Doable? 🤔