https://github.com/irskep/sphinx-better-theme

A nice-looking, customizable theme for Sphinx
https://github.com/irskep/sphinx-better-theme

Last synced: 11 days ago
JSON representation

A nice-looking, customizable theme for Sphinx

• Host: GitHub
• URL: https://github.com/irskep/sphinx-better-theme
• Owner: irskep
• License: other
• Created: 2013-08-10T22:55:07.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-05-04T17:14:08.000Z (over 1 year ago)
• Last Synced: 2024-09-20T04:48:31.571Z (about 2 months ago)
• Language: HTML
• Homepage: http://sphinx-better-theme.readthedocs.org/en/latest/
• Size: 105 KB
• Stars: 41
• Watchers: 6
• Forks: 10
• Open Issues: 18
• Metadata Files:
  • Readme: Readme.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
A Better Sphinx Theme

---------------------

`Read the documentation`_

`See a demo`_

.. _Read the documentation: https://sphinx-better-theme.readthedocs.org/en/latest/

.. _See a demo: https://sphinx-better-theme.readthedocs.org/en/latest/demos.html

What is this?

^^^^^^^^^^^^^

This is a modified version of the default Sphinx theme with the following

goals:

1. Remove frivolous colors, especially hard-coded ones

2. Improve readability by limiting width and using more whitespace

3. Encourage visual customization through CSS, not themeconf

4. Use semantic markup

v0.1 meets goals one and two. Goal three is partially complete; it's simple to

add your own CSS file without creating a whole new theme. `Open a ticket` if

you'd like something changed.

.. _Open a ticket: https://github.com/irskep/sphinx-better-theme/issues/new

Compatibility

"""""""""""""

sphinx-better-theme is compatible with Sphinx 0.6.4+ and Jinja 2.3.1+. Older

versions may work but have not been tested.

Installation

^^^^^^^^^^^^

Get it from PyPI::

    > pip install sphinx-better-theme

Or `download the zip file`_ and run the usual command::

    > python setup.py install

.. _download the zip file: https://github.com/irskep/sphinx-better-theme/archive/master.zip

Once the package is installed, make these changes to ``conf.py`` to direct

Sphinx to use the theme::

    from better import better_theme_path

    html_theme_path = [better_theme_path]

    html_theme = 'better'