Update multiversion documentation#827
Merged
dgarcia360 merged 6 commits intoscylladb:masterfrom Jul 4, 2023
Merged
Conversation
Collaborator
dgarcia360
commented
Jun 23, 2023
dgarcia360
commented
- Improve multiversion command documentation.
- Identify all the prerequistes necessary to run the software.
- Add WSL as an alternative terminal to Git Bash.
Collaborator
|
@dgarcia360 The docs look great, but I can't apply the procedure. Let's discuss this. |
|
|
||
| 2. The previous command should generate HTML docs under the ``docs/_build/dirhtml`` directory. | ||
|
|
||
| .. tip:: If the command raises an error, see :ref:`Troubleshooting <No_Matching_Refs_Found>` for help. |
Collaborator
There was a problem hiding this comment.
This PR removes troubleshooting no-maching-refs-found problem, but this is exactly what happened to me during the procedure.
Co-authored-by: Anna Stuchlik <[email protected]>
Collaborator
|
@dgarcia360 Are you going to make any updates to this PR? For example, remove info about Git Bash? |
…ersion-documentation' of github.com:dgarcia360/sphinx-scylladb-theme-1 into update-multiversion-documentation
Collaborator
Author
|
@annastuchlik PR updated |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.