Skip to content

Commit

Permalink
Update documentation theme (#125)
Browse files Browse the repository at this point in the history
* change readthedocs theme

* small change to update PR

* remove excess docs badges and refer docs status to latest
  • Loading branch information
bvreede authored Oct 20, 2022
1 parent 970226a commit 2b8e449
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 13 deletions.
12 changes: 2 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,10 @@ era5cli
:target: https://opensource.org/licenses/Apache-2.0
:alt: License

.. image:: https://readthedocs.org/projects/era5cli/badge/?version=stable
:target: https://era5cli.readthedocs.io/en/stable/?badge=stable
.. image:: https://readthedocs.org/projects/era5cli/badge/?version=latest
:target: https://era5cli.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://img.shields.io/badge/docs-stable-brightgreen.svg
:target: http://era5cli.readthedocs.io/en/stable/?badge=stable
:alt: Stable Documentation

.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
:target: http://era5cli.readthedocs.io/en/latest/?badge=latest
:alt: Latest Documentation

.. image:: https://github.com/eWaterCycle/era5cli/actions/workflows/test_codecov.yml/badge.svg
:target: https://github.com/eWaterCycle/era5cli/actions/workflows/test_codecov.yml
:alt: Github Actions
Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
author = 'era5cli team'

# The full version, including alpha/beta/rc tags
release = '1.0.0'
release = '1.3.1'


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -54,7 +54,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
2 changes: 1 addition & 1 deletion docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Install from PyPI
~~~~~~~~~~~~~~~~~
era5cli is available as a package in `PyPI <https://pypi.org/project/era5cli/>`_.

To install from PyPI, the following command can be used:
To install from PyPI, use the following command:
::

pip install era5cli
Expand Down
1 change: 1 addition & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ pytest-flake8
pytest-cov
Sphinx
sphinx-argparse
sphinx_rtd_theme

0 comments on commit 2b8e449

Please sign in to comment.