Use the Jupyter book sphinx theme instead of RTD

.github/workflows/docs.yml

@@ -34,6 +34,7 @@ jobs:
  env:
  CONDA_REQUIREMENTS: requirements.txt
  CONDA_REQUIREMENTS_DEV: requirements-dev.txt
+ CONDA_REQUIREMENTS_DOC: requirements-doc.txt
  PYTHON: 3.8
 
  steps:
@@ -91,6 +92,10 @@ jobs:
  echo "Capturing dependencies from $CONDA_REQUIREMENTS_DEV"
  cat $CONDA_REQUIREMENTS_DEV >> $requirements_file
  fi
+ if [ ! -z "$CONDA_REQUIREMENTS_DOC" ]; then
+ echo "Capturing dependencies from $CONDA_REQUIREMENTS_DOC"
+ cat $CONDA_REQUIREMENTS_DOC >> $requirements_file
+ fi
  if [ "$DEPENDENCIES" == "optional" ]; then
  echo "Capturing optional dependencies from $CONDA_REQUIREMENTS_OPTIONAL"
  cat $CONDA_REQUIREMENTS_OPTIONAL >> $requirements_file

README.rst

@@ -22,10 +22,6 @@ Part of the `Fatiando a Terra <https://www.fatiando.org>`__ project
  :alt: Digital Object Identifier for the Zenodo archive
  :target: https://doi.org/10.5281/zenodo.3628741
 
-
-.. placeholder-for-doc-index
-
-
 Disclaimer
 ----------
 
@@ -38,6 +34,9 @@ or send us a message on our
 `Slack chatroom <https://contact.fatiando.org>`__.
 
 
+.. placeholder-for-doc-index
+
+
 About
 -----
 

doc/Makefile

@@ -20,8 +20,10 @@ help:
  @echo " linkcheck check all external links for integrity"
  @echo " doctest run all doctests embedded in the documentation (if enabled)"
 
-clean:
+clean-html:
  rm -rf $(BUILDDIR)/html/*
+
+clean: clean-html
  rm -rf $(BUILDDIR)/doctrees
  rm -rf $(BUILDDIR)/linkcheck
  rm -rf api/generated

doc/_static/custom.css

@@ -0,0 +1,6 @@
+span.project-version {
+ color: #999999;
+ font-size: 0.8em;
+ font-weight: 600;
+ margin-left: 5px;
+}

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 %}