opensafely / opensafely/documentation
MkDocs build is slow
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
This doesn't matter too much for an actual build during deployment, but is inconvenient for local editing.
This is primarily due to the use of the multirepo plugin. It takes over 10 seconds on my computer, which is a little bit slow when you're editing and wanting quick feedback on appearance. It used to take something like 1-2 seconds.
It apparently wants to clone the project every time you edit files; upstream issue: jdoiro3/mkdocs-multirepo-plugin#129.
Other non-ideal workarounds for local editing:
- remove the ehrQL section entirely when not working on it
- edit the repository URL to point to a local clone
#1317 might help here.
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 reproducing the local MkDocs build and reviewing how the multirepo plugin is configured. Compare the behavior with upstream issue jdoiro3/mkdocs-multirepo-plugin#129 and related issue #1317. Done means local editing provides faster feedback without requiring the ehrQL section to be removed or the repository URL to be changed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100