|version| |python| |license| |ci|

.. |version| image:: https://img.shields.io/pypi/v/alabaster :target: https://pypi.org/project/alabaster/ :alt: PyPI - Package Version .. |python| image:: https://img.shields.io/pypi/pyversions/alabaster :target: https://pypi.org/project/alabaster/ :alt: PyPI - Python Version .. |license| image:: https://img.shields.io/pypi/l/alabaster :target: https://github.com/bitprophet/alabaster/blob/main/LICENSE :alt: PyPI - License .. |ci| image:: https://img.shields.io/circleci/build/github/bitprophet/alabaster/main :target: https://app.circleci.com/pipelines/github/bitprophet/alabaster :alt: CircleCI

What is Alabaster?

Alabaster is a visually (c)lean, responsive, configurable theme for the Sphinx <http://sphinx-doc.org>_ documentation system. It is Python 3.6+ 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 <http://alabaster.readthedocs.io>, paramiko.org <http://paramiko.org>, fabfile.org <http://fabfile.org>_ and pyinvoke.org <http://pyinvoke.org>_.

For more documentation, please see http://alabaster.readthedocs.io. For a roadmap, see the maintainer's roadmap page <http://bitprophet.org/projects#roadmap>_.

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