docs: Add no IDE live preview #281
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
AlexanderLanin
added
infrastructure
nicu1989
force-pushed
the
nicu1989_docs_livepreview
branch
from
273c683 to
1c478e3
Compare
nicu1989
force-pushed
the
nicu1989_docs_livepreview
branch
4 times, most recently
from
128c414 to
eef955f
Compare
Use sphinx-autobuild to implement live preview without requiring VSCode integration. This allows previewing on save independent of IDE. Signed-off-by: Nicolae Dicu <[email protected]>
nicu1989
force-pushed
the
nicu1989_docs_livepreview
branch
from
eef955f to
97bf832
Compare
AlexanderLanin
approved these changes
Feb 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.
Improvement
Description
Use sphinx-autobuild to allow live preview in the browser. It does not require any IDE to perform live preview.
Added in the README as another way to preview docs.
Related ticket
closes [#181 ] (improvement ticket)