Skip to content

Commit

Permalink
minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
devanshshukla99 committed Jul 24, 2024
1 parent 500c9fc commit dd26c54
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 6 deletions.
2 changes: 0 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -254,5 +254,3 @@
"sphinx": ("https://www.sphinx-doc.org/", None),
"gitpython": ("https://gitpython.readthedocs.io/en/stable/", None),
}

pygments_style = "github-dark"
4 changes: 2 additions & 2 deletions docs/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Configuration File Arguments
.. warning::

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

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

Select any particular branches/tags to build.

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

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

Expand Down
2 changes: 1 addition & 1 deletion sphinx_versioned/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ def main(
Passed directly to sphinx. Specify more than once for more logging in sphinx. [Default = `False`]
loglevel : :class:`str`
Provide logging level. Example `--log` debug, [Default='info']
force_branch : :class:`str`
force_branch : :class:`bool`
Force branch selection. Use this option to build detached head/commits. [Default = `False`]
Returns
Expand Down
2 changes: 1 addition & 1 deletion tests/test_branch_selection.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def test_parse_branch_selection_regex(branches, select, exclude):
"quite": False,
"verbose": True,
"main_branch": "main",
"force_branches": True,
"force_branch": True,
"select_branch": parsed_select,
"exclude_branch": parsed_exclude,
},
Expand Down

0 comments on commit dd26c54

Please sign in to comment.