feat: ドキュメントのバージョン表示を改善し、テーマを変更

Author: shima004

docs/source/_templates/versions.html

@@ -1,31 +1,96 @@
+<style>
+  .rst-versions {
+    border: 1px solid #ddd;
+    padding: 10px;
+    border-radius: 5px;
+    margin-bottom: 20px;
+  }
+
+  .rst-current-version {
+    font-weight: bold;
+    cursor: pointer;
+  }
+
+  .rst-other-versions {
+    display: none; /* 初期状態では非表示 */
+  }
+
+  .rst-other-versions dl {
+    margin: 0;
+    padding: 0;
+  }
+
+  .rst-other-versions dt {
+    font-weight: bold;
+    margin-top: 10px;
+  }
+
+  .rst-other-versions dd {
+    margin: 0;
+    padding: 0 0 0 10px;
+    display: flex;
+    flex-wrap: wrap;
+  }
+
+  .rst-other-versions a {
+    text-decoration: none;
+    color: #27ae60;
+    margin-right: 10px;
+  }
+
+  .rst-other-versions a:hover {
+    text-decoration: underline;
+  }
+</style>
+
 <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="rst-current-version"
+    data-toggle="rst-current-version"
+    onclick="toggleVersions()"
+  >
     Language: {{ current_language }}
     <span class="fa fa-caret-down"></span>
   </span>
   <div class="rst-other-versions">
     {% if languages|length >= 1 %}
     <dl>
       <dt>{{ _('Languages') }}</dt>
-      {% for the_language, url in languages %}
-      <dd><a href="{{ url }}/index.html">{{ the_language }}</a></dd>
-      {% endfor %}
+      <dd>
+        {% for the_language, url in languages %}
+        <a href="{{ url }}/index.html">{{ the_language }}</a>
+        {% endfor %}
+      </dd>
     </dl>
     {% endif %}
     <!-- {% if versions|length >= 1 %}
-    <dl>
-      <dt>{{ _('Versions') }}</dt>
-      {% for the_version, url in versions %}
-        <dd><a href="{{ url }}/index.html">{{ the_version }}</a></dd>
-      {% endfor %}
-    </dl>
-    {% endif %}
-    <br>
-    </dl> -->
+      <dl>
+        <dt>{{ _('Versions') }}</dt>
+        {% for the_version, url in versions %}
+          <dd><a href="{{ url }}/index.html">{{ the_version }}</a></dd>
+        {% endfor %}
+      </dl>
+      {% endif %}
+      <br>
+      </dl> -->
   </div>
 </div>
+
+<script>
+  function toggleVersions() {
+    var versionsDiv = document.querySelector(".rst-other-versions");
+    if (
+      versionsDiv.style.display === "none" ||
+      versionsDiv.style.display === ""
+    ) {
+      versionsDiv.style.display = "block";
+    } else {
+      versionsDiv.style.display = "none";
+    }
+  }
+</script>

docs/source/conf.py

@@ -37,7 +37,12 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_book_theme"
+
+html_sidebars = {
+    "**": ["navbar-logo.html", "versions.html", "search-button-field.html", "sbt-sidebar-nav.html"]
+}
+
 html_static_path = ["_static"]
 
 locale_dirs = ["locale"]
@@ -53,7 +58,7 @@
     current_language = os.environ.get("current_language")
     current_version = os.environ.get("current_version")
 
-    # we set the html_context wit current language and version 
+    # we set the html_context wit current language and version
     # and empty languages and versions for now
     html_context = {
         'current_language' : current_language,
@@ -63,8 +68,8 @@
     }
 
 
-    # and we append all versions and langauges accordingly 
-    # we treat t he main branch as latest 
+    # and we append all versions and langauges accordingly
+    # we treat t he main branch as latest
     if (current_version == 'latest'):
         html_context['languages'].append(['en', pages_root])
         html_context['languages'].append(['ja', pages_root+'/ja'])

docs/source/index.rst

@@ -71,7 +71,6 @@ adf-core-pythonを始めるには、インストールに従い、このドキ
    :maxdepth: 1
    :caption: APIドキュメント
 
-   genindex
    modindex
    search