Build a mkdocs plugin for multi-repo docs generation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 88
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
At the moment, the multi doc pulling and consolidating is done in an adhoc way. Other people are searching for a multi docs plugin for mkdocs.
- generate_docs could be made into a mkdocs plugin using the
on_configevent to regenerate the config - OUTSIDE_DOCS file could be put inside the plugin configuration
Contributor guide
No contributing guide indexed for this repository
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 locating the existing generate_docs workflow and the OUTSIDE_DOCS file, then read MkDocs's on_config plugin event and the linked MkDocs issue 265. Done means the multi-repository document pulling and consolidation work through a MkDocs plugin, with OUTSIDE_DOCS represented in plugin configuration instead of a separate file.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100