Skip to content

Commit

Permalink
[docs] Clarify which branch to checkout
Browse files Browse the repository at this point in the history
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
  • Loading branch information
real-yfprojects committed Sep 17, 2024
1 parent faa9076 commit 6257207
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/sphinx/guide/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ This guide assumes that you installed `sphinx-polyversion` into the development
environment of your project and have written some documentation that builds
with `sphinx-build`.

For this tool it doesn't matter which branch you are working on as it will
query the whole git repository for branches and tags to build documentation for.
However you will need to fetch all the references that should be visible to the tool.
However the tool will always use the configuration currently checked out.

.. TODO: link sphinx docs / sphinx build
Configuring `sphinx-polyversion`
Expand Down

0 comments on commit 6257207

Please sign in to comment.