Add make target to serve docs locally #840
Merged
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
With this commit we add the make target `serve-docs` which starts a web server locally so docs changes can be easily checked.
danielmitterdorfer
added
enhancement
hub-cap
approved these changes
Dec 18, 2019
Makefile
Outdated
| @@ -92,6 +92,9 @@ lint: check-venv | |||
| docs: check-venv | |||
| cd docs && $(MAKE) html | |||
|
|
|||
| serve-docs: docs | |||
| @cd docs/_build/html && python3 -m http.server | |||
There was a problem hiding this comment.
Since the docs/Makefile already has a make serve, it might make sense to do cd docs && $(MAKE) serve instead.
There was a problem hiding this comment.
Good catch. Let's use that.
|
@elasticmachine run tests |
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.
With this commit we add the make target
serve-docswhich starts a webserver locally so docs changes can be easily checked.