mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2025-02-25 18:55:21 -06:00
67bb54d450
Fixes #557 #523 * Remove old conf file setup * Split changelog to its ownfile * Remove changelog from readme * Update introduction sentence * Fix wording of intro * Remove readme table of contents * Move links to there sections * Remove config * Create configuring.rst * Remove todo * Remove installing docs from readme * Create installing.rst * Remove contributing section from readme * Create contributing.rst * Include basic info in readme The rest gets pointed to our actual docs * Add new files to toctree * Fix configuring options title * Set logo_only to True Also, remove documentation of theme options. We have actual docs for this. * Include readme on index page
33 lines
616 B
ReStructuredText
33 lines
616 B
ReStructuredText
|
|
************
|
|
Installation
|
|
************
|
|
|
|
Via Python Package
|
|
==================
|
|
|
|
Install the package (or add it to your ``requirements.txt`` file):
|
|
|
|
.. code:: bash
|
|
|
|
pip install sphinx_rtd_theme
|
|
|
|
In your ``conf.py`` file:
|
|
|
|
.. code:: python
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
|
|
Via Git or Download
|
|
===================
|
|
|
|
Symlink or subtree the ``sphinx_rtd_theme/sphinx_rtd_theme`` repository into your documentation at
|
|
``docs/_themes/sphinx_rtd_theme`` then add the following two settings to your Sphinx
|
|
``conf.py`` file:
|
|
|
|
.. code:: python
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_theme_path = ["_themes", ]
|
|
|