13
Is there a Python package to create single .md file documentation from docstrings?
(programming.dev)
Welcome to the Python community on the programming.dev Lemmy instance!
Past
November 2023
October 2023
July 2023
August 2023
September 2023
Just spent the last two weeks (no exaggeration) putting documentation together. Ensuring references resolve correctly is the time consuming bit.
extlinks, nitpick_ignore, autodoc_type_aliases, intersphinx_mapping, multiple extensions, and building inventories using sphobjinv, Table of contents using sphinx-external-toc-strict links to both ref and docs.
The table of contents supports both
.mdand.rstfiles. With the caveat that the initial file must beindex.rst.Having to relearn all this crap to do the same thing (e.g. mkdocs)? Would rather stick a fork in my eye.
Here is a sample TOC config file wreck _toc.yml from package wreck. Shows
globs:,file:,url:links.This one includes both
.rstand.mdstrict TOC _toc.ymlOutput is a user manual web site or a pdf.
markdown and restructuredText are input files, not the end goal.