question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Recursively generate documentation for entire module without creating individual markdown files

See original GitHub issue

We’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:closed
  • Created 2 years ago
  • Reactions:11
  • Comments:7 (5 by maintainers)

github_iconTop GitHub Comments

3reactions
jmkd3vcommented, Apr 11, 2021

Take a look at #179 (comment) (not yet sure if the issue is duplicate or not)

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.

2reactions
oprypincommented, Apr 11, 2021

Take a look at https://github.com/mkdocstrings/mkdocstrings/issues/179#issuecomment-784631904 (not yet sure if the issue is duplicate or not)

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found