Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation theme to sphinx-book-theme #92

Merged
merged 1 commit into from Oct 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 3 additions & 15 deletions README.rst
Expand Up @@ -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
----------

Expand All @@ -43,6 +40,9 @@ or send us a message on our
`Slack chatroom <http://contact.fatiando.org>`__.


.. placeholder-for-doc-index


About
-----

Expand Down Expand Up @@ -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>`__
17 changes: 0 additions & 17 deletions boule/version.py

This file was deleted.

18 changes: 18 additions & 0 deletions 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;
}
107 changes: 0 additions & 107 deletions doc/_static/style.css

This file was deleted.

14 changes: 4 additions & 10 deletions doc/_templates/autosummary/class.rst
Expand Up @@ -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 %}
Expand Down
34 changes: 0 additions & 34 deletions doc/_templates/breadcrumbs.html

This file was deleted.

24 changes: 1 addition & 23 deletions doc/_templates/layout.html
Expand Up @@ -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 %}
4 changes: 2 additions & 2 deletions doc/api/index.rst
@@ -1,7 +1,7 @@
.. _api:

API Reference
=============
List of functions and classes (API)
===================================

.. automodule:: boule

Expand Down