Recursively generate documentation for entire module without creating individual markdown files
See original GitHub issueWe’d like to generate documentation for our entire module without generating a markdown file for each file. I assume this is possible, but I am having trouble doing it myself.
I have tried just adding ::: package-name
to a file - which does document all contents - but it’s all in one file, which is not the ideal solution. Ideally, I’d like classes and files to be automatically placed in the sidebar.
I’m using mkdocstrings version 0.15.0
. The contents of my mkdocs.yml
file does not seem to be relevant.
Issue Analytics
- State:
- Created 2 years ago
- Reactions:11
- Comments:7 (5 by maintainers)
Top Results From Across the Web
python 3.x - How do I recursively generate documentation of ...
I want to extract all the docstrings of all the python files inside this project. In this project all the modules are imported...
Read more >Recipes - mkdocstrings
Recipes. On this page you will find various recipes, tips and tricks for mkdocstrings and more generally Markdown documentation.
Read more >pdoc API documentation
pdoc auto-generates API documentation that follows your project's Python module hierarchy. pdoc's main feature is a focus on simplicity: pdoc aims to do...
Read more >sphinx.ext.autodoc – Include documentation from docstrings
This extension can import the modules you are documenting, and pull in documentation from docstrings in a semi-automatic way. ... For Sphinx (actually,...
Read more >Documentation generator for q ( .qd )
qdoc supports documenting the behavior of a namespace or the whole project. Use Markdown files called */README.md to add namespace or project level...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
While this does partially solve the problem, it’s not a solution if it can’t actually add the items to the nav. I assume I can write up a script that does this and then edits the nav in the mkdocs.yml file before building, but I was hoping for a more streamlined solution.
Take a look at https://github.com/mkdocstrings/mkdocstrings/issues/179#issuecomment-784631904 (not yet sure if the issue is duplicate or not)