Repository navigation
ci: build the docs site with ProperDocs as well as MkDocs - #108
Merged
Merged
Conversation
ProperDocs continues MkDocs 1.x and reads the same config and the theme's mkdocs.themes entry point. Make the CI docs job a matrix over mkdocs and properdocs so that a regression affecting only ProperDocs fails CI. The docs plugins already install properdocs, so this adds no dependencies. The offline build script runs mkdocs itself, so it only runs on the mkdocs leg. Say in every language's installation guide that the theme works with ProperDocs. Fixes #107
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #107
What
docsjob is now a matrix overtool: [mkdocs, properdocs]. Each leg builds the main site and the three examples with--strict.npm run build:offlinecallsmkdocsitself, so it runs only on themkdocsleg.Why
ProperDocs carries on MkDocs 1.x, and it's where 1.x users are expected to move once MkDocs 2.0 ships. It reads
mkdocs.ymland the theme'smkdocs.themesentry point, so the theme already works with it. Until now nothing checked that. The docs plugins already installproperdocs(see #94), so the new leg adds no dependencies. The Pages and Release workflows still build only withmkdocs.Checked
All eight builds pass locally with
--strict: the main site and each ofexamples/{rss,gen-files,diagrams}, once withmkdocsand once withproperdocs. The new paragraph shows up on the built installation page in every language.Independent of #106; the two can merge in either order.