sphinx-docs-theme 0.3.5

Sphinx Theme for documentation sites.

A minimalist Bootstrap-based HTML5 theme for Sphinx. For generating documentation sites.

Check the latest docs to find out how to set it up.

The skin has been adapted from the static template Docs Bootstrap Template, and it is the visual reference to be followed by the project.

Features

• Minimalist and reactive look

• HTML5

• Bootstrap 3

• Font Awesome icons

• highlight.js for syntax highlighting

• Prepared for Facebook’s Open Graph and Twitter Cards

Demo

To check the Sphinx Docs Theme at work take a look at the documentation, linked below this section, which is created with Sphinx and making use of this theme.

Documentation

Documentation sources are included with the project, and used to generate the documentation sites:

• The latest docs are always generated for the latest release, kept in the ‘master’ branch

• The development docs are generated from the latest code in the ‘develop’ branch

The source files for the docs, a small Sphinx project, are kept in the ‘docs folder.

These can be built if needed:

$ python setup.py build_docs

Usage

The project is a Sphinx theme, which can be used in a similar way to any other such theme.

Prerequisites

Sphinx is required to make use of this theme, as it is meant to be integrated into a Sphinx project. To find more information about this check its webpage, which will also tell which Python interpreters can be used.

All other Python dependencies are indicated on the requirements.txt file.

These dependencies can be installed with:

$ pip install --upgrade -r requirements.txt

The frontend libraries are defined as npm dependencies, and require this package manager to be defined.

These dependencies can be installed with:

$ python setup.py frontend

Installing

The project is offered as a Pypi package, and using pip is the preferred way to install it. For this use the following command;

$ pip install sphinx-docs-theme

If needed, manual installation is possible:

$ python setup.py install

Using it as a dependency

If the project has been installed in the local libraries repository, it can be used just by adding the following lines to the conf.py file of any Sphinx project:

import sphinx_docs_theme

html_theme = 'sphinx_docs_theme'
html_theme_path = sphinx_docs_theme.get_html_theme_path()

Using it from the Sphinx themes folder

Another possibility is just adding the project code, contained int the ‘sphinx_docs_theme’ folder, to the themes folder of your Sphinx project, which is:

docs\_themes\sphinx_docs_theme\

And then it is just needed to add the following files to the conf.py file:

html_theme = 'sphinx_docs_theme'
html_theme_path = ["_themes", ]

Collaborate

Any kind of help with the project will be well received, and there are two main ways to give such help:

• Reporting errors and asking for extensions through the issues management

• or forking the repository and extending the project

Issues management

Issues are managed at the GitHub project issues tracker, where any Github user may report bugs or ask for new features.

Getting the code

If you wish to fork or modify the code, visit the GitHub project page, where the latest versions are always kept. Check the ‘master’ branch for the latest release, and the ‘develop’ for the current, and stable, development version.

License

The project has been released under the MIT License.