feat: Add Tox environment for documentation preview #642
Conversation
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
github-actions
bot
added
enhancement
4 tasks
jorgepiloto
requested changes
Mar 6, 2025
Member
jorgepiloto
left a comment
jorgepiloto
left a comment
There was a problem hiding this comment.
Thanks for adding this, @Revathyvenugopal162. Just left one comment for adding this environment to the doc group and renaming it.
tox.ini
Outdated
| python -m build {toxinidir} | ||
| python -m build {toxinidir} | ||
|
|
||
| [testenv:doc-preview] |
Member
There was a problem hiding this comment.
Let's add this with the rest of the doc environments and rename it serve. This is the usual name:
[testenv:doc-{clean,links,html,pdf,serve}]
skip_install:
clean,serve: true
commands =
...
serve: stb serve "{toxinidir}/{env:BUILD_DIR}/html" --open-browser
jorgepiloto
requested changes
Mar 6, 2025
Member
jorgepiloto
left a comment
jorgepiloto
left a comment
There was a problem hiding this comment.
Just left one suggestion regarding the deps.
tox.ini
Outdated
Comment on lines
42
to
43
| deps= | ||
| serve: sphinx-theme-builder[cli] @ https://github.com/pradyunsg/sphinx-theme-builder/archive/d9f620b1a73839728c95b596343595d3952ec8bf.zip |
Member
There was a problem hiding this comment.
This is not required. The build system is already installing the STB tool.
jorgepiloto
approved these changes
Mar 6, 2025
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.
This PR introduces a new Tox environment,
[testenv:doc-serve], to build and serve the documentation locally.