diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..380897e --- /dev/null +++ b/README.rst @@ -0,0 +1,33 @@ +.. 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.9 or newer and Sphinx 3.4 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/. |