-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Select/exclude a branch from processing #69
Merged
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
devanshshukla99
force-pushed
the
exclude-branch
branch
from
March 4, 2024 12:37
74aa322
to
2d9c493
Compare
devanshshukla99
force-pushed
the
exclude-branch
branch
from
March 17, 2024 10:21
e45ee50
to
8209431
Compare
devanshshukla99
force-pushed
the
exclude-branch
branch
from
March 19, 2024 13:46
5f9c618
to
8ce6730
Compare
devanshshukla99
added
the
documentation
Improvements or additions to documentation
label
Mar 19, 2024
devanshshukla99
commented
Mar 19, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍🏻
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
By default,
sphinx-versioned-docs
will try to build all tags and branches present in the git repo.However, this behaviour can be augmented using the
--branch
command-line-argument, to select/exclude particular branch(s) and tag(s).They can be specified in the
--branch
argument as:Mention the branch/tag name in the CLI arugment like:
Either of the two options above will select
main
,v2.0
and will only build these.Mention the branch/tag name with
-
in the CLI argument like:The above command will build all available branches and tags except
main
,v2.0
For selecting and excluding simultaneously:
Mention the branch/tag name with
-
in the CLI argument like:The above command will only build
main
and will exclude-v2.0
(untouched because the package was only buildingmain
).Some caveats while selecting/excluding branches:
When selecting some branches, the extension will only build these.
When excluding some branches, the extension will exclude those and build all other branches/tags present.
Excluding a branch will always take precedence over selecting a branch.
Build tests passed
Codestyle tests passed
Added test coverage for new features
Documentation updated to reflect the changes
Fixes #68