Skip to content

Commit c358947

Browse files
committed
docs/faq: Improve answer regarding old branches/tags.
1 parent 2c21aa7 commit c358947

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/faq.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,16 @@ Then it copies the data for each version into separate temporary directories, bu
2424
The :file:`conf.py` file from the currently checked out branch will be used to build old versions, so it's not necessary to make changes old branches or tags to add support for ``sphinx-multiversion``.
2525
This also means that theme improvements, template changes, etc. will automatically be applied to old versions without needing to add commits.
2626

27+
2728
Do I need to make changes to old branches or tags?
2829
==================================================
2930

30-
No, you don't. ``sphinx-multiversion`` will always use the :file:`conf.py` file from you currently checked out branch.
31+
No, you don't. ``sphinx-multiversion`` will always use the :file:`conf.py` file from your currently checked out branch.
32+
33+
The downside is that this behaviour restricts the kinds of changes you may do to your configuration, because it needs to retain compatibility with old branches.
34+
For example, if your :file:`conf.py` file hardcodes a path (e.g. for opening a file), but that file does not exist in some older branches that you want to build documentation for, this will cause issues.
35+
In these cases you will need to add a check if a file actually exists and adapt the path accordingly.
36+
3137

3238
What are the license terms of ``sphinx-multiversion``?
3339
======================================================

0 commit comments

Comments
 (0)