Creating an example gallery using pdoc3
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the example layout in examples/plot_example.py and the documented API in module/module.py, then compare the requested workflow with Sphinx-Gallery's generated .rst files. Determine whether pdoc3 can support the gallery and cross-references; done means a documented, working workflow that produces a matplotlib-style example gallery.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100