Skip to content

Commit dd26c54

Browse files
minor fixes
1 parent 500c9fc commit dd26c54

File tree

4 files changed

+4
-6
lines changed

4 files changed

+4
-6
lines changed

docs/conf.py

-2
Original file line numberDiff line numberDiff line change
@@ -254,5 +254,3 @@
254254
"sphinx": ("https://www.sphinx-doc.org/", None),
255255
"gitpython": ("https://gitpython.readthedocs.io/en/stable/", None),
256256
}
257-
258-
pygments_style = "github-dark"

docs/settings.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Configuration File Arguments
104104
.. warning::
105105

106106
Unfortunately, due to limitations of the current implementation, all path variables
107-
like git-path, output path, local ``conf.py`` path cannot be select
107+
like git-path, output path, local conf.py path cannot be select
108108
via configuration file argument and must be specified in CLI arguments.
109109

110110
.. option:: sv_project_url: <url>
@@ -115,7 +115,7 @@ Configuration File Arguments
115115

116116
Select any particular branches/tags to build.
117117

118-
The branch/tag names can be specified in an array with names separated by ``,`` or ``|``.
118+
The branch/tag names can be separated by ``,`` or ``|`` and supports regex.
119119

120120
Example: ``sv_select_branch=["main", "v2.0"]``
121121

sphinx_versioned/__main__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ def main(
115115
Passed directly to sphinx. Specify more than once for more logging in sphinx. [Default = `False`]
116116
loglevel : :class:`str`
117117
Provide logging level. Example `--log` debug, [Default='info']
118-
force_branch : :class:`str`
118+
force_branch : :class:`bool`
119119
Force branch selection. Use this option to build detached head/commits. [Default = `False`]
120120
121121
Returns

tests/test_branch_selection.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ def test_parse_branch_selection_regex(branches, select, exclude):
5151
"quite": False,
5252
"verbose": True,
5353
"main_branch": "main",
54-
"force_branches": True,
54+
"force_branch": True,
5555
"select_branch": parsed_select,
5656
"exclude_branch": parsed_exclude,
5757
},

0 commit comments

Comments
 (0)