docs: prepare Makefile and conf.py for sphinxcontrib-versioning

bareos · Dec 12, 2018 · 3f00975 · 3f00975
1 parent d92c88f
commit 3f00975
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/manuals/en/new_main_reference/Makefile b/docs/manuals/en/new_main_reference/Makefile
@@ -12,6 +12,7 @@ BUILDDIR      = BareosMainReference
 # Put it first so that "make" without argument is like "make help".
 all:
 	./convert_all_tex_files_to_rst.sh
+	#sphinx-versioning -l source/conf.py  build docs/manuals/en/new_main_reference/source/ docs/manuals/en/new_main_reference/BareosMainReference/
 	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	#@$(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 

diff --git a/docs/manuals/en/new_main_reference/source/conf.py b/docs/manuals/en/new_main_reference/source/conf.py
@@ -214,3 +214,17 @@
      author, 'BareosMainReference', 'One line description of project.',
      'Miscellaneous'),
 ]
+
+
+import re
+# settings for sphinxcontrib-versioning
+scv_whitelist_branches = (re.compile(r'^master$'),
+#        re.compile('sphinx-versioning$'),
+        re.compile(r'^bareos-18.2$'))
+scv_show_banner = True
+scv_priority = 'branches'
+scv_root_ref = 'bareos-18.2'
+scv_banner_main_ref = 'bareos-18.2'
+
+#scv_root_ref = 'dev/pstorz/bareos-18.2/sphinx-versioning'
+#scv_banner_main_ref = 'dev/pstorz/bareos-18.2/sphinx-versioning'