.. image:: https://img.shields.io/pypi/v/alabaster.svg :target: https://pypi.org/project/alabaster/ :alt: Package on PyPI

.. image:: https://github.com/sphinx-doc/alabaster/actions/workflows/test.yml/badge.svg :target: https://github.com/sphinx-doc/alabaster/actions/workflows/test.yml :alt: CI Status

.. image:: https://readthedocs.org/projects/alabaster/badge/ :target: https://alabaster.readthedocs.io/ :alt: Documentation Status

.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg :target: https://opensource.org/license/BSD-3-Clause :alt: BSD 3 Clause

What is Alabaster?

Alabaster is a visually (c)lean, responsive, configurable theme for the Sphinx <https://www.sphinx-doc.org>_ documentation system. It requires Python 3.10 or newer and Sphinx 6.2 or newer.

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 <https://alabaster.readthedocs.io/>, paramiko.org <https://www.paramiko.org>, fabfile.org <https://www.fabfile.org>_ and pyinvoke.org <https://www.pyinvoke.org>_.

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