|
2 | 2 | Installation |
3 | 3 | ============ |
4 | 4 |
|
5 | | -The bare minimum required to install Alabaster is as follows: |
| 5 | +Alabaster requires **Sphinx 1.6 or newer**, and is included as the default |
| 6 | +theme. |
6 | 7 |
|
7 | | -* If you're on **Sphinx 1.2 or older**: |
| 8 | +.. note:: |
| 9 | + If you distribute your documentation via `Read the Docs |
| 10 | + <https://readthedocs.org>`_, you will need to explicitly enable |
| 11 | + Alabaster by adding this line to your ``conf.py``:: |
8 | 12 |
|
9 | | - * ``pip install alabaster`` or equivalent. |
10 | | - * Add the following to your ``conf.py`` so Alabaster's theme location & |
11 | | - mini-extension are located & loaded: |
| 13 | + .. code:: python |
12 | 14 |
|
13 | | - .. code-block:: python |
| 15 | + html_theme = 'alabaster' |
14 | 16 |
|
15 | | - import alabaster |
16 | | -
|
17 | | - html_theme_path = [alabaster.get_path()] |
18 | | - extensions = ['alabaster'] |
19 | | - html_theme = 'alabaster' |
20 | | -
|
21 | | - * If you've installed Alabaster by hand (without using ``pip``) and/or are |
22 | | - doing funky things to your PYTHONPATH, you may need to replace the |
23 | | - ``alabaster.get_path()`` call with your own explicit string, as per `the |
24 | | - Sphinx config docs |
25 | | - <http://sphinx-doc.org/config.html#confval-html_theme_path>`_. |
26 | | - |
27 | | -* If you have **Sphinx 1.3 or above**: |
28 | | - |
29 | | - * You already have Alabaster installed as a dependency! No need to manually |
30 | | - install it or explicitly load it. |
31 | | - |
32 | | - .. note:: |
33 | | - If you distribute your documentation via the excellent `Read the Docs |
34 | | - <https://readthedocs.org>`_, you may need to explicitly enable |
35 | | - Alabaster (as RTD defaults to using its own theme) by adding this line |
36 | | - to your ``conf.py``:: |
37 | | - |
38 | | - html_theme = 'alabaster' |
39 | | - |
40 | | -* **Either way**, add an explicit ``html_sidebars`` setting so Alabaster's |
41 | | - customized sidebar templates are loaded: |
| 17 | +To set-up Alabaster, add an explicit ``html_sidebars`` setting so |
| 18 | +Alabaster's customized sidebar templates are loaded: |
42 | 19 |
|
43 | 20 | .. code-block:: python |
44 | 21 | |
|
0 commit comments