https://github.com/enthought/enthought-sphinx-theme

Sphinx theme for Enthought projects
https://github.com/enthought/enthought-sphinx-theme

Last synced: about 1 year ago
JSON representation

Sphinx theme for Enthought projects

• Host: GitHub
• URL: https://github.com/enthought/enthought-sphinx-theme
• Owner: enthought
• License: other
• Created: 2014-10-07T10:15:31.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2023-05-18T15:54:13.000Z (about 3 years ago)
• Last Synced: 2025-03-25T06:41:52.855Z (over 1 year ago)
• Language: CSS
• Size: 1.48 MB
• Stars: 0
• Watchers: 42
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
enthought-sphinx-theme

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

`Sphinx `_ theme for `Enthought projects

`_, derived from the `Scipy theme

`_.

Installation

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

Install this as a normal Python package. The theme files are in the package

data.

In your project's ``conf.py`` file, do the following::

    import enthought_sphinx_theme

    html_theme_path = [enthought_sphinx_theme.theme_path]

    html_theme = 'enthought'

Theme options

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

The theme takes the followin options in the ``html_theme_options``

configuration variable:

- ``rootlinks``

  List of tuples ``(url, link_name)`` to show in the beginning of the

  breadcrumb list on the top left. You can override it by defining an

  `edit_link` block in ``searchbox.html``.

- ``sidebar``

  One of ``"left"``, ``"right"``, ``"none"``.  Defines where the sidebar

  should appear.

- ``navigation_links``

  ``True`` or ``False``. Whether to display "next", "prev", "index", etc.

  links.

- ``use_default_logo``

  ``True`` or ``False``. Whether to use the default Enthought logo in the

  sidebar. If the ``html_logo`` configuration parameter is non-empty, it will

  override this. Set this to ``False`` and ``html_logo`` to empty only if you

  want no logo at all.

- ``use_default_favicon``

  ``True`` or ``False``. Whether to use the default Enthought logo as the

  favicon.  If the ``html_favicon`` configuration parameter is non-empty, it

  will override this. Set this to ``False`` and ``html_favicon`` to empty only

  if you want no favicon at all.

The following blocks are defined:

- ``layout.html:header``

   

  Block at the top of the page, for logo etc.