IntenseWebs/sphinx_rtd_theme
3
0
Fork 0
mirror of https://github.com/readthedocs/sphinx_rtd_theme.git synced 2025-02-25 18:55:21 -06:00
Code Issues Packages Projects Releases Wiki Activity
Sphinx theme for readthedocs.org
743 Commits 59 Branches 49 Tags 25 MiB
Sass 47.2%
HTML 20.5%
JavaScript 15.4%
Python 13.1%
Dockerfile 2.3%
Other 1.5%
146457a6c8
Go to file
Aaron Carlisle 146457a6c8
Docs: restructure (#573) 
The idea here is to make the docs have a more flat design that exposes more pages from the main index.
2018-03-01 10:15:53 -05:00
.github Create CODE_OF_CONDUCT.md (#562) 2018-02-02 18:43:18 -05:00
docs Docs: restructure (#573) 2018-03-01 10:15:53 -05:00
js Concisify 2018-01-16 09:56:18 +01:00
sass Allow versions popup to scroll (#576) 2018-02-17 10:46:52 -05:00
sphinx_rtd_theme Add document block and rename bodycontent content 2018-02-15 09:47:29 -05:00
tests Adds testing and hopefully a final fix for the empty toctree issue 2017-03-06 14:45:58 -08:00
.gitignore Adds testing and hopefully a final fix for the empty toctree issue 2017-03-06 14:45:58 -08:00
.travis.yml No double build 2017-12-20 20:37:27 -08:00
Apache-License-2.0.txt Add local google font 2014-08-25 16:13:38 -04:00
bower.json Run grunt (#522) 2017-12-27 21:33:02 -05:00
Gruntfile.js Uglify during build 2017-12-28 10:22:16 +01:00
LICENSE Initial commit 2013-10-17 10:10:50 -07:00
MANIFEST.in Include fontawesome-webfont.woff2 in pip package 2017-03-05 19:50:44 +01:00
OFL-License.txt Add local google font 2014-08-25 16:13:38 -04:00
package.json Match minor dependency version for consistency 2017-12-29 16:23:17 +01:00
README.rst Docs: Fix typos (#584) 2018-02-28 17:53:23 -05:00
setup.cfg Configure package as py2, py3 universal wheel 2016-09-26 20:26:33 +02:00
setup.py Add Sphinx Framework for PyPi (#470) 2017-10-02 18:07:24 -04:00
tox.ini With deps 2017-12-20 20:39:13 -08:00

README.rst 

**************************
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 primary 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>`__.