mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2025-02-25 18:55:21 -06:00
ecbc09f22a
The fonts are in `static/fonts`, but setup.py has been installing `static/font`. That didn't seem to work for me. This changes setup.py to match the actual directory.
************************** 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://travis-ci.org/rtfd/sphinx_rtd_theme.svg?branch=master :target: https://travis-ci.org/rtfd/sphinx_rtd_theme :alt: Build Status .. 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 The ``sphinx_rtd_theme`` is a sphinx_ theme designed to look modern and be mobile-friendly. This theme is primarily focused to be used on readthedocs.org_ but can work with your own sphinx projects. To read more and see a working demo_ head over to readthedocs.org_. .. _sphinx: http://www.sphinx-doc.org .. _readthedocs.org: http://www.readthedocs.org .. _demo: https://sphinx-rtd-theme.readthedocs.io/en/latest/ Installing ========== The theme is distributed on PyPI_ and can be installed with pip:: pip install sphinx_rtd_theme For more information read the full installing docs `here <https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html>`__. .. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme Configuration ============= The ``sphinx_rtd_theme`` is highly customizable on both the page level and on a global level. To see all the possible configuration options read the configuring docs `here <https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html>`__. Contributing ============ If you would like to help improve the theme or have more control over the theme in case of a fork please read our contributing guide `here <https://sphinx-rtd-theme.readthedocs.io/en/latest/contributing.html>`__.