Versioning init

README.md

@@ -19,6 +19,7 @@ brew install sphinx-doc
 pip3 install sphinx-autobuild
 pip3 install sphinx-book-theme || pip install git+https://github.com/executablebooks/sphinx-book-theme.git@master
 pip3 install sphinxcontrib.yt
+pip3 install sphinx-multiversion
 ```
 
 ### Development
@@ -56,4 +57,4 @@ To update Sphinx Book Theme:
 - `pip install sphinx-book-theme==<tag_version>` || `pip install git+https://github.com/executablebooks/sphinx-book-theme.git@<branch_name>` eg. `pip install sphinx-book-theme==0.0.42`
 
 To deploy theme update:
-- Build and publish according to production release process
+- Build and publish according to production release process

source/_templates/versioning.html

@@ -0,0 +1,8 @@
+{% if versions %}
+<h3>{{ _('Versions') }}</h3>
+<ul>
+    {%- for item in versions %}
+    <li><a href="{{ item.url }}">{{ item.name }}</a></li>
+    {%- endfor %}
+</ul>
+{% endif %}

source/conf.py

@@ -25,18 +25,31 @@ copyright = '2021, Start9 Labs, Inc'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinxcontrib.yt'
+    'sphinxcontrib.yt',
+    'sphinx_multiversion'
     # 'sphinxcontrib.needs'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
+# HTML sidebar widgets
+# html_sidebars = {
+#     '**': [
+#         'versioning.html',
+#     ],
+# }
+
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
 
+# Multiversion settings
+smv_tag_whitelist = 'None'
+smv_prefer_remote_refs = True
+# smv_branch_whitelist = master
+
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -56,12 +69,13 @@ html_theme_options = {
     # "theme_dev_mode": True,
     "path_to_docs": "source",
     "repository_url": "https://github.com/Start9Labs/documentation",
+    "repository_branch": "master",
     "use_edit_page_button": True,
     "use_issues_button": True,
     "use_repository_button": True,
     "extra_navbar": "Powered by <a href=\"https://start9.com\">Start9</a>", # Will be displayed underneath the left navbar"
     "show_navbar_depth": 1,
-    "use_download_button": False,
+    "use_download_button": True,
     "use_edit_page_button": True,
     "launch_buttons": {
         "main_site": "https://start9.com",

source/support/FAQ/dev-faq.rst

@@ -22,7 +22,7 @@ With sufficient effort, most any software with the ability to be self-hosted cou
 - Already 'dockerized'
 
 Which possible formats can I use to write the :code:`manifest`, :code:`config_spec`, and :code:`config_rules` files?
----------------------------------------------------------------------------------------------------------------------
+--------------------------------------------------------------------------------------------------------------------
 JSON, TOML, or YAML are valid options.
 
 I'm getting errors on the `embassy-sdk pack` step.  What's going on?