https://github.com/sphinx-doc/alabaster

Lightweight, configurable Sphinx theme
https://github.com/sphinx-doc/alabaster

Last synced: 29 days ago
JSON representation

Lightweight, configurable Sphinx theme

• Host: GitHub
• URL: https://github.com/sphinx-doc/alabaster
• Owner: sphinx-doc
• License: other
• Created: 2013-12-07T00:03:15.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-07-26T18:14:36.000Z (5 months ago)
• Last Synced: 2024-11-06T18:52:01.381Z (about 1 month ago)
• Language: HTML
• Homepage: http://alabaster.readthedocs.io/
• Size: 540 KB
• Stars: 735
• Watchers: 34
• Forks: 189
• Open Issues: 69
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.rst

Awesome Lists containing this project

• awesome-starz - sphinx-doc/alabaster - Lightweight, configurable Sphinx theme (HTML)
• best-of-python-dev - GitHub - 49% open · ⏱️ 10.01.2024): (Documentation)

README

        
.. 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

`_ 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

`_, `paramiko.org `_,

`fabfile.org `_ and `pyinvoke.org `_.

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