A a theme for the Sphinx documentation generator (sphinx.pocoo.org). Is a mix of f6, Fusion_Sphinx and mainly Pristine themes.
HTML ApacheConf
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
static
LICENSE
README.rst
layout.html
theme.conf

README.rst

Lynx Sphinx Theme

This is a theme for the Sphinx documentation generator (sphinx.pocoo.org). Is a mix of f6, Fusion_Sphinx and mainly Pristine themes.

Installation

Follow these steps to use this theme in your project's documentation:

  1. Put this as _themes folder into your documentation folder.

  2. Add the following code to your conf.py:

    sys.path.append(os.path.abspath('_themes'))
    html_theme_path = ['_themes']
    html_theme = 'lynx'
    

Options

The following theme options are available. Overwrite the default values below using the html_theme_options dictionary in conf.py:

index_logo
Filename of an image in _static used as replacement for the <h1> in index.rst. No default.
index_logo_height
Height of the index_logo image in pixels. No default.
page_width
Page width in pixels. Defaults to 960.
sidebar_width
Sidebar width in pixels. Defaults to 260.
github_fork
Github repository URL for a fork-me ribbon (user/repo). No default.
bitbucket_fork
Bitbucket repository URL for a fork-me ribbon (user/repo). No default.

Resources

The resources used in this theme are: