Преглед изворни кода

docs/configuration: Document automatic branch/tag skipping in note

Jan Holthuis пре 5 година
родитељ
комит
7fbdb902da
1 измењених фајлова са 1 додато и 2 уклоњено
  1. 1 2
      docs/configuration.rst

+ 1 - 2
docs/configuration.rst

@@ -33,8 +33,7 @@ You can override all of these values inside your :file:`conf.py`.
 
 .. note::
 
-    You can check which tags/branches are matched by running ``sphinx-multiversion`` with the ``--dump-metadata`` flag.
-
+    You can check which tags/branches are matched by running ``sphinx-multiversion`` with the ``--dump-metadata`` flag. Branches or tags that don't contain both the sphinx source directory and the :file:`conf.py` file will be skipped automatically.
 
 Tag/Branch/Remote whitelists
 ============================