Add support for notebooks in the documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 3
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 3
Description
We can use the mkdocs-jupyter-plugin for mkdocs. See example from dsis-python-client.
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 by reviewing the MkDocs configuration and the mkdocs-jupyter plugin documentation, then compare the linked dsis-python-client example. Done means notebooks are included in the project documentation and render correctly in the generated MkDocs site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100