blob: 3ceeaa288552ac5d102af09ee276de8bfa94e15c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
=========================
Alabaster: a Sphinx theme
=========================
.. include:: ../README.rst
Features
========
* Easy ability to install/use as a Python package (tip o' the hat to `Dave &
Eric's sphinx_rtd_theme <https://github.com/readthedocs/sphinx_rtd_theme>`_ for
showing the way);
* Style tweaks compared to the source themes, such as better code-block
alignment, Github button placement, page source link moved to footer,
improved (optional) related-items sidebar item, and many more;
* Many customization hooks, including toggle of various sidebar & footer
components; header/link/etc color control; etc;
* Improved documentation for all customizations (pre-existing & new).
Project background
==================
Alabaster is a modified (with permission) version of `Kenneth Reitz's
<https://www.kennethreitz.org/>`_ `"krTheme" Sphinx theme
<https://github.com/kennethreitz-archive/kr-sphinx-themes>`_ (it's the one used
in his `Requests <https://requests.readthedocs.io/>`_ project). Kenneth's
theme was itself originally based on Armin Ronacher's `Flask
<https://flask.palletsprojects.com/>`_ theme. Many thanks to both for their hard work.
Implementation notes
====================
* `Fabric #419 <https://github.com/fabric/fabric/issues/419>`_ contains a lot of
general exposition & thoughts as I developed Alabaster, specifically with a
mind towards using it on two nearly identical 'sister' sites (single-version
www 'info' site & versioned API docs site).
* Alabaster includes/requires a tiny Sphinx extension on top of the theme
itself; this is just so we can inject dynamic metadata (like Alabaster's own
version number) into template contexts. It doesn't add any additional
directives or the like, at least not yet.
.. toctree::
:hidden:
:glob:
*
|
