Merge branch 'master' of github.com:incebellipipo/mclsimpy

Author: incebellipipo

.readthedocs.yaml

@@ -1,9 +1,9 @@
 version: 2
 
 build:
-  os: "ubuntu-20.04"
+  os: "ubuntu-22.04"
   tools:
-    python: "3.8"
+    python: "3.12"
 
 python:
   # Install our python package before building the docs
@@ -12,4 +12,10 @@ python:
       path: .
 
 sphinx:
+  configuration: docs/conf.py
   fail_on_warning: true
+
+versions:
+  only:
+    - master
+    - /^v\d+\.\d+/

docs/Makefile

@@ -4,7 +4,8 @@
 # You can set these variables from the command line, and also
 # from the environment for the first two.
 SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
+SPHINXBUILD   ?= sphinx-multiversion
+# SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
 

docs/_templates/versions.html

@@ -0,0 +1,27 @@
+{%- if current_version %}
+<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+  <span class="rst-current-version" data-toggle="rst-current-version">
+    <span class="fa fa-book"> Other Versions</span>
+    v: {{ current_version.name }}
+    <span class="fa fa-caret-down"></span>
+  </span>
+  <div class="rst-other-versions">
+    {%- if versions.tags %}
+    <dl>
+      <dt>Tags</dt>
+      {%- for item in versions.tags %}
+      <dd><a href="{{ item.url }}">{{ item.name }}</a></dd>
+      {%- endfor %}
+    </dl>
+    {%- endif %}
+    {%- if versions.branches %}
+    <dl>
+      <dt>Branches</dt>
+      {%- for item in versions.branches %}
+      <dd><a href="{{ item.url }}">{{ item.name }}</a></dd>
+      {%- endfor %}
+    </dl>
+    {%- endif %}
+  </div>
+</div>
+{%- endif %}

docs/conf.py

@@ -24,13 +24,18 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
     'sphinx.ext.autosummary',
-    'sphinx_rtd_theme'
+    'sphinx_rtd_theme',
+    'sphinx_multiversion'
 ]
 
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-
-
+html_sidebars = {
+    '**': [
+        'versions.html',
+    ],
+}
+smv_default_ref = 'master'
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

docs/index.rst

@@ -42,10 +42,6 @@ The package have some of the same features as the `MSS Toolbox <https://se.mathw
 
    getting_started
    modules/simulator
-   modules/control
-   modules/guidance
-   modules/thrust_allocation
-   modules/observer
    modules/waves
    modules/utils
 

docs/requirements.txt

@@ -1,2 +1,3 @@
 sphinx==7.1.2
-sphinx-rtd-theme==1.3.0rc1
+sphinx-rtd-theme==3.0.2
+sphinx-multiversion