pdoc3 / pdoc

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
https://pdoc3.github.io/pdoc/
GNU Affero General Public License v3.0
1.14k stars 146 forks source link

Creating an example gallery using pdoc3 #320

Open cgadal opened 3 years ago

cgadal commented 3 years ago

I have successfully managed to build a documentation using pdoc3 for a project that can be represented as:

 module/
├── html
└── module/
    └── module.py

I am trying to add to my documentation and to the module a gallery of examples:

 module/
├── html
└── examples/
    └── plot_example.py
└── module/
    └── module.py

How can I achieve that using pdoc 3 ?

With Sphinx, there is the module Sphinx-Gallery which produces .rst files that are taken by sphink to create the gallery. Is there any workflow to use these files with pdoc3 ?

The overall idea would be to achieve a gallery example such as the one of matplotlib, and to have these examples cross-referenced with the used functions.

kernc commented 3 years ago

I'd say the closest to this in pdoc comes .. include:: reST directive.