Add a local build-docs make target #1264
Open
Conversation
This file contains 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
Collaborator
elliotgunton
commented
Nov 13, 2024
elliotgunton
commented
- Make it easier to check doc changes locally before making a PR
- Also removed deprecated options in mkdocs.yml
* Make it easier to check doc changes before making a PR * Also remove deprecated options in mkdocs.yml Signed-off-by: Elliot Gunton <[email protected]>
elliotgunton
added
the
type:skip-changelog
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1264 +/- ##
=====================================
Coverage 86.2% 86.2%
=====================================
Files 60 60
Lines 4113 4113
Branches 660 660
=====================================
Hits 3547 3547
Misses 393 393
Partials 173 173 ☔ View full report in Codecov by Sentry. |
alicederyn
reviewed
Nov 14, 2024
| @@ -124,6 +124,11 @@ init-files: | |||
| examples: ## Generate documentation files for examples | |||
| @(cd docs && poetry run python generate.py) | |||
|
|
|||
| .PHONY: build-docs | |||
| build-docs: ## Generate (and host) documentation locally | |||
| @python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt | |||
There was a problem hiding this comment.
Would it be worth making a separate venv for this so we don't accidentally disrupt the Poetry one?
There was a problem hiding this comment.
Not worth the effort for now as it's not supported natively by poetry https://stackoverflow.com/questions/70739858/how-to-create-a-brand-new-virtual-environment-or-duplicate-an-existing-one-in-po
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.