https://github.com/ionelmc/sphinx-py3doc-enhanced-theme

A theme based on the theme of https://docs.python.org/3/ with some responsive enhancements.
https://github.com/ionelmc/sphinx-py3doc-enhanced-theme

Last synced: 7 months ago
JSON representation

A theme based on the theme of https://docs.python.org/3/ with some responsive enhancements.

• Host: GitHub
• URL: https://github.com/ionelmc/sphinx-py3doc-enhanced-theme
• Owner: ionelmc
• License: bsd-2-clause
• Created: 2014-05-31T10:20:30.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2021-06-06T12:44:31.000Z (over 4 years ago)
• Last Synced: 2024-10-14T14:47:21.277Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 2.59 MB
• Stars: 24
• Watchers: 5
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - ionelmc/sphinx-py3doc-enhanced-theme - A theme based on the theme of https://docs.python.org/3/ with some responsive enhancements. (others)

README

          
========

Overview

========

.. start-badges

.. list-table::

    :stub-columns: 1

    * - docs

      - |docs|

    * - tests

      - | |travis| |requires|

        |

    * - demo

      - `default `_,

        `bare `_

    * - package

      - | |version| |wheel| |supported-versions| |supported-implementations|

        | |commits-since|

.. |docs| image:: https://readthedocs.org/projects/sphinx-py3doc-enhanced-theme/badge/?style=flat

    :target: https://sphinx-py3doc-enhanced-theme.readthedocs.io/

    :alt: Documentation Status

.. |travis| image:: https://api.travis-ci.com/ionelmc/sphinx-py3doc-enhanced-theme.svg?branch=master

    :alt: Travis-CI Build Status

    :target: https://travis-ci.com/github/ionelmc/sphinx-py3doc-enhanced-theme

.. |requires| image:: https://requires.io/github/ionelmc/sphinx-py3doc-enhanced-theme/requirements.svg?branch=master

    :alt: Requirements Status

    :target: https://requires.io/github/ionelmc/sphinx-py3doc-enhanced-theme/requirements/?branch=master

.. |version| image:: https://img.shields.io/pypi/v/sphinx-py3doc-enhanced-theme.svg

    :alt: PyPI Package latest release

    :target: https://pypi.org/project/sphinx-py3doc-enhanced-theme

.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-py3doc-enhanced-theme.svg

    :alt: PyPI Wheel

    :target: https://pypi.org/project/sphinx-py3doc-enhanced-theme

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-py3doc-enhanced-theme.svg

    :alt: Supported versions

    :target: https://pypi.org/project/sphinx-py3doc-enhanced-theme

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-py3doc-enhanced-theme.svg

    :alt: Supported implementations

    :target: https://pypi.org/project/sphinx-py3doc-enhanced-theme

.. |commits-since| image:: https://img.shields.io/github/commits-since/ionelmc/sphinx-py3doc-enhanced-theme/v2.4.0.svg

    :alt: Commits since latest release

    :target: https://github.com/ionelmc/sphinx-py3doc-enhanced-theme/compare/v2.4.0...master

.. end-badges

A theme based on the theme of https://docs.python.org/3/ with some responsive enhancements.

* Free software: BSD 2-Clause License

Installation

============

::

    pip install sphinx_py3doc_enhanced_theme

Add this in your documentation's ``conf.py``:

.. sourcecode:: python

    import sphinx_py3doc_enhanced_theme

    html_theme = "sphinx_py3doc_enhanced_theme"

    html_theme_path = [sphinx_py3doc_enhanced_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/ionelmc/sphinx-py3doc-enhanced-theme/',

        'bodyfont': '"Lucida Grande",Arial,sans-serif',

        'headfont': '"Lucida Grande",Arial,sans-serif',

        'codefont': 'monospace,sans-serif',

        'linkcolor': '#0072AA',

        'visitedlinkcolor': '#6363bb',

        'extrastyling': False,

    }

    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_py3doc_enhanced_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_py3doc_enhanced_theme

    html_theme = "theme"

    html_theme_path = [sphinx_py3doc_enhanced_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/