sloria / alabaster

Sphinx theme based on alabaster based on Kr based on Flask

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

This is my fork of @bitprophet's alabaster theme. The sloria branch contains all my modifications. Some of these modifications may get merged upstream, some of them may not.

To use this in a project, include the following in your requirements.txt file.

git+https://github.com/sloria/alabaster.git@sloria

Then follow the instructions below to configure.


What is Alabaster?

Alabaster is a visually (c)lean, responsive, configurable theme for the Sphinx documentation system. It is Python 2+3 compatible.

It began as a third-party theme, and is still maintained separately, but as of Sphinx 1.3, Alabaster is an install-time dependency of Sphinx and is selected as the default theme.

Live examples of this theme can be seen on this project's own website, paramiko.org, fabfile.org and pyinvoke.org.

For more documentation, please see http://alabaster.readthedocs.io.

Note

You can install the development version via pip install -e git+https://github.com/bitprophet/alabaster/#egg=alabaster.

About

Sphinx theme based on alabaster based on Kr based on Flask

License:Other


Languages

Language:HTML 55.1%Language:Python 44.6%Language:CSS 0.3%