Update dev docs to include doc testing #2930
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
lucasmoura
reviewed
Jan 29, 2024
There was a problem hiding this comment.
Hi @dheyay, thanks for this addition to the dev-docs. I have just a small suggestion here, but let me know what you think
lucasmoura
approved these changes
Jan 31, 2024
s-makin
reviewed
Feb 6, 2024
| @@ -61,6 +61,18 @@ This will build *and serve* the documentation at http://127.0.0.1:8000 -- this | |||
| gives you a live preview of any changes you make (and save) to the | |||
| documentation without needing to continually rebuild. | |||
|
|
|||
| ## Doc testing | |||
|
|
|||
| Before running the `make` command, make sure to download the python venv module by running the following command: | |||
There was a problem hiding this comment.
Suggested change
| Before running the `make` command, make sure to download the python venv module by running the following command: | |
| Before running the `make` command, make sure to download the Python `venv` module by running the following command: |
dheyay
force-pushed
the
dev-docs-update
branch
from
1079e04
to
a9ff5ab
Compare
dheyay
force-pushed
the
dev-docs-update
branch
from
a9ff5ab
to
dab0f48
Compare
s-makin
approved these changes
Feb 7, 2024
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.
Why is this needed?
This PR solves all of our problems because...
Testing documentation updated to include local testing for updates to docs.
Test Steps
Checklist
Does this PR require extra reviews?