search

ml-tooling / lazydocs

📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.
MIT License
197 stars 38 forks source link

Create one page md file for all the docstrings #52

Closed ventouris closed 7 months ago

ventouris commented 1 year ago

Feature description:

Instead of creating several md files for each module, lazydocs create one single page with everything in there.

Problem and motivation:

I am currently working on several small projects that might have 2-4 functions per file. I want to gather all the documentation in a single page where I can easily find the module/function/class I want to without jumping from one page to the other.

Is this something you're interested in working on?

Probably no, due to lack of lazydocs code experience.

github-actions[bot] commented 1 year ago

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days

github-actions[bot] commented 11 months ago

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days

github-actions[bot] commented 8 months ago

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days

epogrebnyak commented 8 months ago

Does importing all functions to a single module then running lazydocs on it work for you? Even with import *.

This is probably something you can do on your end with existing lazydoc functionality.