| 1 |
Metadata-Version: 2.1 |
| 2 |
Name: alabaster |
| 3 |
Version: 1.0.0 |
| 4 |
Summary: A light, configurable Sphinx theme |
| 5 |
Maintainer: Adam Turner |
| 6 |
Maintainer-email: Jeff Forcier <[email protected]> |
| 7 |
Requires-Python: >=3.10 |
| 8 |
Description-Content-Type: text/x-rst |
| 9 |
Classifier: Development Status :: 5 - Production/Stable |
| 10 |
Classifier: Framework :: Sphinx |
| 11 |
Classifier: Framework :: Sphinx :: Theme |
| 12 |
Classifier: Intended Audience :: Developers |
| 13 |
Classifier: License :: OSI Approved :: BSD License |
| 14 |
Classifier: Operating System :: OS Independent |
| 15 |
Classifier: Programming Language :: Python :: 3 |
| 16 |
Classifier: Programming Language :: Python :: 3 :: Only |
| 17 |
Classifier: Programming Language :: Python :: 3.10 |
| 18 |
Classifier: Programming Language :: Python :: 3.11 |
| 19 |
Classifier: Programming Language :: Python :: 3.12 |
| 20 |
Classifier: Programming Language :: Python :: 3.13 |
| 21 |
Classifier: Programming Language :: Python :: Implementation :: CPython |
| 22 |
Classifier: Programming Language :: Python :: Implementation :: PyPy |
| 23 |
Classifier: Topic :: Documentation |
| 24 |
Classifier: Topic :: Documentation :: Sphinx |
| 25 |
Classifier: Topic :: Software Development :: Documentation |
| 26 |
Project-URL: Changelog, https://alabaster.readthedocs.io/en/latest/changelog.html |
| 27 |
Project-URL: Documentation, https://alabaster.readthedocs.io/ |
| 28 |
Project-URL: Download, https://pypi.org/project/alabaster/ |
| 29 |
Project-URL: Homepage, https://alabaster.readthedocs.io/ |
| 30 |
Project-URL: Issue tracker, https://github.com/sphinx-doc/alabaster/issues |
| 31 |
Project-URL: Source, https://github.com/sphinx-doc/alabaster |
| 32 |
|
| 33 |
.. image:: https://img.shields.io/pypi/v/alabaster.svg |
| 34 |
:target: https://pypi.org/project/alabaster/ |
| 35 |
:alt: Package on PyPI |
| 36 |
|
| 37 |
.. image:: https://github.com/sphinx-doc/alabaster/actions/workflows/test.yml/badge.svg |
| 38 |
:target: https://github.com/sphinx-doc/alabaster/actions/workflows/test.yml |
| 39 |
:alt: CI Status |
| 40 |
|
| 41 |
.. image:: https://readthedocs.org/projects/alabaster/badge/ |
| 42 |
:target: https://alabaster.readthedocs.io/ |
| 43 |
:alt: Documentation Status |
| 44 |
|
| 45 |
.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg |
| 46 |
:target: https://opensource.org/license/BSD-3-Clause |
| 47 |
:alt: BSD 3 Clause |
| 48 |
|
| 49 |
|
| 50 |
What is Alabaster? |
| 51 |
================== |
| 52 |
|
| 53 |
Alabaster is a visually (c)lean, responsive, configurable theme for the `Sphinx |
| 54 |
<https://www.sphinx-doc.org>`_ documentation system. |
| 55 |
It requires Python 3.10 or newer and Sphinx 6.2 or newer. |
| 56 |
|
| 57 |
It began as a third-party theme, and is still maintained separately, but as of |
| 58 |
Sphinx 1.3, Alabaster is an install-time dependency of Sphinx and is selected |
| 59 |
as the default theme. |
| 60 |
|
| 61 |
Live examples of this theme can be seen on `this project's own website |
| 62 |
<https://alabaster.readthedocs.io/>`_, `paramiko.org <https://www.paramiko.org>`_, |
| 63 |
`fabfile.org <https://www.fabfile.org>`_ and `pyinvoke.org <https://www.pyinvoke.org>`_. |
| 64 |
|
| 65 |
For more documentation, please see https://alabaster.readthedocs.io/. |
| 66 |
|