pdoc icon indicating copy to clipboard operation
pdoc copied to clipboard

Creating an example gallery using pdoc3

Open cgadal opened this issue 3 years ago • 1 comments

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.

cgadal avatar Mar 02 '21 18:03 cgadal

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

kernc avatar Mar 03 '21 04:03 kernc