You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
125 lines
3.5 KiB
125 lines
3.5 KiB
==============================================
|
|
Enhanced Sphinx theme (based on Python 3 docs)
|
|
==============================================
|
|
|
|
Theme customized for https://pyrocko.org
|
|
|
|
!! Includes pyrocko piwik tracking code !!
|
|
|
|
.. list-table::
|
|
:stub-columns: 1
|
|
|
|
* - docs
|
|
- |docs|
|
|
* - tests
|
|
- | |travis|
|
|
* - demo
|
|
- `default <http://ionelmc.github.io/sphinx-py3doc-enhanced-theme/default/>`_,
|
|
`bare <http://ionelmc.github.io/sphinx-py3doc-enhanced-theme/bare/>`_
|
|
* - package
|
|
- |version| |downloads|
|
|
|
|
.. |docs| image:: https://readthedocs.org/projects/sphinx-py3doc-enhanced-theme/badge/?style=flat
|
|
:target: https://readthedocs.org/projects/sphinx-py3doc-enhanced-theme
|
|
:alt: Documentation Status
|
|
|
|
.. |travis| image:: http://img.shields.io/travis/ionelmc/sphinx-py3doc-enhanced-theme/master.svg?style=flat&label=Travis
|
|
:alt: Travis-CI Build Status
|
|
:target: https://travis-ci.org/ionelmc/sphinx-py3doc-enhanced-theme
|
|
|
|
.. |version| image:: http://img.shields.io/pypi/v/sphinx-py3doc-enhanced-theme.svg?style=flat
|
|
:alt: PyPI Package latest release
|
|
:target: https://pypi.python.org/pypi/sphinx-py3doc-enhanced-theme
|
|
|
|
.. |downloads| image:: http://img.shields.io/pypi/dm/sphinx-py3doc-enhanced-theme.svg?style=flat
|
|
:alt: PyPI Package monthly downloads
|
|
:target: https://pypi.python.org/pypi/sphinx-py3doc-enhanced-theme
|
|
|
|
A theme based on https://github.com/ionelmc/sphinx-py3doc-enhanced-theme
|
|
|
|
* Free software: BSD license
|
|
|
|
Installation
|
|
============
|
|
|
|
::
|
|
|
|
pip install sphinx_sleekcat_theme
|
|
|
|
Add this in your documentation's ``conf.py``:
|
|
|
|
.. sourcecode:: python
|
|
|
|
import sphinx_sleekcat_theme
|
|
html_theme = "sphinx_sleekcat_theme"
|
|
html_theme_path = [sphinx_sleekcat_theme.get_html_theme_path()]
|
|
|
|
Customization
|
|
=============
|
|
|
|
No extra styling
|
|
----------------
|
|
|
|
This theme has some extra styling like different fonts, text shadows for headings, slightly different styling for inline code and code blocks.
|
|
|
|
To get the original styling Python 3 docs have add this in you ``conf.py``:
|
|
|
|
.. sourcecode:: python
|
|
|
|
html_theme_options = {
|
|
'githuburl': 'https://github.com/pyrocko/pyrocko/',
|
|
'bodyfont': '"Lucida Grande",Arial,sans-serif',
|
|
'headfont': '"Lucida Grande",Arial,sans-serif',
|
|
'codefont': 'monospace,sans-serif',
|
|
'linkcolor': '#0072AA',
|
|
'visitedlinkcolor': '#6363bb',
|
|
'extrastyling': False,
|
|
'googlewebfonturl': 'http://fonts.googleapis.com/css?family=Rubik+One|Kalam',
|
|
'fontawesome': 'https://use.fontawesome.com/d51e5252e5.js',
|
|
}
|
|
pygments_style = 'friendly'
|
|
|
|
Custom favicon
|
|
--------------
|
|
|
|
To have a custom favicon create a ``theme`` directory near your ``conf.py`` and add this ``theme.conf`` in it:
|
|
|
|
.. sourcecode:: ini
|
|
|
|
[theme]
|
|
inherit = sphinx_sleekcat_theme
|
|
|
|
Then create a ``favicon.png`` in the ``static`` directory.
|
|
|
|
And then edit your ``conf.py`` to have something like this:
|
|
|
|
.. sourcecode:: python
|
|
|
|
import sphinx_sleekcat_theme
|
|
html_theme = "theme"
|
|
html_theme_path = [sphinx_sleekcat_theme.get_html_theme_path(), "."]
|
|
|
|
The final file structure should be like this::
|
|
|
|
docs
|
|
├── conf.py
|
|
└── theme
|
|
├── static
|
|
│ └── favicon.png
|
|
└── theme.conf
|
|
|
|
A bit of extra css
|
|
------------------
|
|
|
|
.. sourcecode:: python
|
|
|
|
html_theme_options = {
|
|
'appendcss': 'div.body code.descclassname { display: none }',
|
|
}
|
|
|
|
Examples
|
|
========
|
|
|
|
* http://python-aspectlib.readthedocs.org/en/latest/
|
|
* http://python-manhole.readthedocs.org/en/latest/
|