Update documentation theme to sphinx-book-theme (#92)

Bump up the pinned version of sphinx and the theme. Copy the configuration and format from Pooch but no major structural changes to the docs.
fatiando · Oct 16, 2021 · 98e8503 · 98e8503
1 parent d7a9303
commit 98e8503
Show file tree

Hide file tree

Showing 14 changed files with 136 additions and 307 deletions.
diff --git a/README.rst b/README.rst
@@ -28,9 +28,6 @@ Part of the `Fatiando a Terra <https://www.fatiando.org>`__ project
     :target: https://doi.org/10.5281/zenodo.3530749
 
 
-.. placeholder-for-doc-index
-
-
 Disclaimer
 ----------
 
@@ -43,6 +40,9 @@ or send us a message on our
 `Slack chatroom <http://contact.fatiando.org>`__.
 
 
+.. placeholder-for-doc-index
+
+
 About
 -----
 
@@ -136,15 +136,3 @@ License
 This is free software: you can redistribute it and/or modify it under the terms
 of the **BSD 3-clause License**. A copy of this license is provided in
 `LICENSE.txt <https://github.com/fatiando/boule/blob/master/LICENSE.txt>`__.
-
-
-Documentation for other versions
---------------------------------
-
-* `Development <http://www.fatiando.org/boule/dev>`__ (reflects the *master* branch on
-  Github)
-* `Latest release <http://www.fatiando.org/boule/latest>`__
-* `v0.2.0 <http://www.fatiando.org/boule/v0.2.0>`__
-* `v0.1.1 <http://www.fatiando.org/boule/v0.1.1>`__
-* `v0.1.0 <http://www.fatiando.org/boule/v0.1.0>`__
-* `v0.0.1 <http://www.fatiando.org/boule/v0.0.1>`__
diff --git a/boule/version.py b/boule/version.py
diff --git a/doc/_static/custom.css b/doc/_static/custom.css
@@ -0,0 +1,18 @@
+span.project-version {
+  color: #999999;
+  font-size: 0.8em;
+  font-weight: 600;
+  margin-left: 5px;
+}
+
+.lead {
+  font-size: 1.5rem;
+}
+
+.front-page-callout {
+  margin-bottom: 4rem;
+}
+
+.sphx-glr-download-link-note {
+  display: none;
+}
diff --git a/doc/_static/style.css b/doc/_static/style.css
diff --git a/doc/_templates/autosummary/class.rst b/doc/_templates/autosummary/class.rst
@@ -4,26 +4,20 @@
 
 .. autoclass:: {{ objname }}
 
-.. rubric:: Attributes
+.. rubric:: Methods Summary
 
 .. autosummary::
-    {% for item in attributes %}
+    {% for item in members %}
+    {% if item in ['__call__'] %}
         {{ objname }}.{{ item }}
+    {% endif %}
     {% endfor %}
-
- {% if methods|length > 1 %}
-
-.. rubric:: Methods
-
-.. autosummary::
     {% for item in methods %}
     {% if item != '__init__' %}
         {{ objname }}.{{ item }}
     {% endif %}
     {% endfor %}
 
-{% endif %}
-
 ----
 
 {% for item in methods %}

diff --git a/doc/_templates/breadcrumbs.html b/doc/_templates/breadcrumbs.html
diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
@@ -19,30 +19,8 @@
 
 {% block htmltitle %}
     {% if title == '' or title == 'Home' %}
-        <title>{{ docstitle|e }}</title>
+        <title>{{ docstitle|striptags|e }}</title>
     {% else %}
         <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
     {% endif %}
 {% endblock %}
-
-
-{% block menu %}
-    {{ super() }}
-
-    {% if menu_links %}
-        <p class="caption">
-            <span class="caption-text">
-            {% if menu_links_name %}
-                {{ menu_links_name }}
-            {% else %}
-                External links
-            {% endif %}
-            </span>
-        </p>
-        <ul>
-            {% for text, link in menu_links %}
-                <li class="toctree-l1"><a href="{{ link }}">{{ text }}</a></li>
-            {% endfor %}
-        </ul>
-    {% endif %}
-{% endblock %}
diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -1,7 +1,7 @@
 .. _api:
 
-API Reference
-=============
+List of functions and classes (API)
+===================================
 
 .. automodule:: boule