search

opensafely-core / ehrql

ehrQL: the electronic health record query language for OpenSAFELY
https://docs.opensafely.org/ehrql/
Other
7 stars 3 forks source link

Revisit mkdocs-multirepo-plugin's imported_repo feature #1126

Open rebkwok opened 1 year ago

rebkwok commented 1 year ago

Databuilder's docs live in this repo, and can be run locally is isolation (just docs-serve). They are pulled into the main documentation site using mkdocs-multirepo-plugin and built alongside the main docs.

mkdocs-multirepo-plugin has a beta feature to allow imported repos to pull in relevant parts of the parent repo so that local builds in the imported repo can use the same styling/theme etc as the parent. This currently doesn't work for our set up - see comments here.

We should revisit this later and see if any further development has made it more feasible.

There is also an issue to make mkdocs configuration inheritance work in the multirepo plugin; this could be another option, if we can have both the main docs and databuilder inherit from the same base config file.

StevenMaude commented 1 year ago

https://github.com/jdoiro3/mkdocs-multirepo-plugin/issues/93 is, I think, one of the issues, I was encountering here.