Skip to content

Commit 6257207

Browse files
[docs] Clarify which branch to checkout
This adds a paragraph to the getting started guide to clarify that it does not matter which branch you configure the tool on. * docs/sphinx/guide/getting-started.rst: Add paragraph regarding current branch
1 parent faa9076 commit 6257207

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/sphinx/guide/getting-started.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ This guide assumes that you installed `sphinx-polyversion` into the development
99
environment of your project and have written some documentation that builds
1010
with `sphinx-build`.
1111

12+
For this tool it doesn't matter which branch you are working on as it will
13+
query the whole git repository for branches and tags to build documentation for.
14+
However you will need to fetch all the references that should be visible to the tool.
15+
However the tool will always use the configuration currently checked out.
16+
1217
.. TODO: link sphinx docs / sphinx build
1318
1419
Configuring `sphinx-polyversion`

0 commit comments

Comments
 (0)