mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2026-10-12 09:24:51 -05:00
Anthony Johnson
e4bcdd8c41
I think we talked about this and never followed through on the next few release, not sure though. After we release a new version, I think we should be updating the repository version to something other than the most current release. The effect would be that the version in the repository would be an alpha/dev release, and so would be possible to differentiate easily between 0.5.2 release on PyPI and 0.5.3alpha1 development release from Git. Right now, we don't follow up with incrementing this version, and so it's harder to tell the difference. This is mostly for our use in development. It adds a small bit of overhead, but is nice and explicit. This PR updates the version in the repository to 1.0.0alpha1. If we had adopted this workflow, the progression would have been: * Release 0.5.2, open PR bumping to 0.5.2 (run `bump2version release` and open PR) * Follow up 0.5.2 release by bumping to `0.5.3alpha1` (run `bump2version patch` and open PR) * We add a new feature, bump to `0.6.0alpha1` (run `bump2version minor` and open PR) * Oops, backwards incompatible change. We bump to `1.0.0alpha1` (run `bump2version major` and open PR) * We're ready for an rc, bump to `1.0.0rc1` (run `bump2version release` and open PR) * Maybe we cut another rc after some fixes * We're ready for final release, bump to `1.0.0` (run `bump2version release` and open PR) * Follow up the release PR by bumping to the next version (run `bump2version patch` and open PR)
**************************
Read the Docs Sphinx Theme
**************************
.. image:: https://img.shields.io/pypi/v/sphinx_rtd_theme.svg
:target: https://pypi.python.org/pypi/sphinx_rtd_theme
:alt: Pypi Version
.. image:: https://circleci.com/gh/readthedocs/sphinx_rtd_theme.svg?style=svg
:alt: Build Status
:target: https://circleci.com/gh/readthedocs/sphinx_rtd_theme
.. image:: https://img.shields.io/pypi/l/sphinx_rtd_theme.svg
:target: https://pypi.python.org/pypi/sphinx_rtd_theme/
:alt: License
.. image:: https://readthedocs.org/projects/sphinx-rtd-theme/badge/?version=latest
:target: http://sphinx-rtd-theme.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
This Sphinx_ theme was designed to provide a great reader experience for
documentation users on both desktop and mobile devices. This theme is used
primarily on `Read the Docs`_ but can work with any Sphinx project. You can find
a working demo of the theme in the `theme documentation`_
.. _Sphinx: http://www.sphinx-doc.org
.. _Read the Docs: http://www.readthedocs.org
.. _theme documentation: https://sphinx-rtd-theme.readthedocs.io/en/latest/
Installation
============
This theme is distributed on PyPI_ and can be installed with ``pip``:
.. code:: console
$ pip install sphinx-rtd-theme
To use the theme in your Sphinx project, you will need to edit
your ``conf.py`` file's ``html_theme`` setting:
.. code:: python
html_theme = "sphinx_rtd_theme"
For more information, including a full example with localized strings enabled,
read the documentation on `installing the theme`_.
.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme
.. _installing the theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html
Configuration
=============
This theme is highly customizable on both the page level and on a global level.
To see all the possible configuration options, read the documentation on
`configuring the theme`_.
.. _configuring the theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html
Contributing
============
If you would like to help modify or translate the theme, you'll find more
information on contributing in our `contributing guide`_.
.. _contributing guide: https://sphinx-rtd-theme.readthedocs.io/en/latest/contributing.html