Move to mkdocs (or equivalent) for docs
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 257
- Forks
- 87
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 29
Description
The project uses Sphinx & ReST for docs. This requires context switching from other docs in the pypsa org, which are increasingly built with mkdocs and written in markdown.
We might not want to go to mkdocs due to the repeated warnings about plugins breaking from v2. Perhaps to Zensical or properdocs?
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 existing Sphinx/ReST documentation setup and the mkdocs-based documentation in other PyPSA repositories. Compare mkdocs, Zensical, and properdocs, including the stated plugin-compatibility concern, before defining a migration plan. Done means a documentation tool and an agreed scope for converting the docs to Markdown are selected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100