base versioning configuration

README.md

@@ -58,3 +58,7 @@ To update Sphinx Book Theme:
 
 To deploy theme update:
 - Build and publish according to production release process
+
+## Versioning
+- Build for versioning: `sphinx-multiversion source build/html`
+- To view version metadata: `sphinx-multiversion source build/html --dump-metadata`

source/_templates/versioning.html

@@ -1,8 +1,15 @@
 {% if versions %}
-<h3>{{ _('Versions') }}</h3>
+<h3>{{ _('Branches') }}</h3>
 <ul>
-    {%- for item in versions %}
+  {%- for item in versions.branches %}
-    <li><a href="{{ item.url }}">{{ item.name }}</a></li>
+  <li><a href="{{ item.url }}">{{ item.name }}</a></li>
-    {%- endfor %}
+  {%- endfor %}
+</ul>
+<h3>{{ _('Tags') }}</h3>
+<ul>
+  {%- for item in versions.tags %}
+  <li><a href="{{ item.url }}">{{ item.name }}</a></li>
+  {%- endfor %}
 </ul>
 {% endif %}
+<h1>*testing versions*</h1>

source/conf.py

@@ -34,12 +34,9 @@ extensions = [
 templates_path = ['_templates']
 
 # HTML sidebar widgets
-# html_sidebars = {
+html_sidebars = {
-#     "**": ["versioning.html"],
+    "**": ["sidebar-logo.html", "search-field.html", "versioning.html", "sbt-sidebar-nav.html", "sbt-sidebar-footer.html"]
-#     '**': [
+}
-#         'versioning.html',
-#     ],
-# }
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -47,18 +44,23 @@ templates_path = ['_templates']
 exclude_patterns = []
 
 # Multiversion settings
-# smv_tag_whitelist = None
+# Whitelist pattern for tags (set to None to ignore all tags)
-# smv_branch_whitelist = None
+smv_tag_whitelist = r'^v\d+\.\d+$' # Include tags like "v2.1"
-# smv_prefer_remote_refs = True
 
-# Versions = {
+# Whitelist pattern for branches (set to None to ignore all branches)
-#     "v0.2.x" : "https://github.com/Start9Labs/documentation",
+smv_branch_whitelist = r'^.*$'
-#     "v0.3.x" : "https://github.com/Start9Labs/documentation/tree/docs-updates"
+
-# }
+# Whitelist pattern for remotes (set to None to use local branches only)
-smv_tag_whitelist = 'None'
+smv_remote_whitelist = r'^(origin)$'
+
+# Pattern for released versions
+smv_released_pattern = r'^tags/.*$'
+
+# Format for versioned output directories inside the build directory
+smv_outputdir_format = 'versions/{ref.name}'
+
+# Determines whether remote or local git branches/tags are preferred if their output dirs conflict
 smv_prefer_remote_refs = True
-# smv_branch_whitelist = master
-
 
 # -- Options for HTML output -------------------------------------------------