@@ -60,7 +60,9 @@ set in ``conf.py`` alongside the rest, e.g.:
6060 }
6161
6262 The following subsections detail available such options, including notes about
63- behavior & default values.
63+ behavior. Default values can be found by viewing `theme.conf
64+ <https://github.com/bitprophet/alabaster/blob/master/alabaster/theme.conf> `_
65+ directly.
6466
6567Variables and feature toggles
6668-----------------------------
@@ -74,47 +76,41 @@ Variables and feature toggles
7476
7577* ``logo_name ``: Set to ``true `` to insert your site's ``project `` name
7678 under the logo image as text. Useful if your logo doesn't include the
77- project name itself. Defaults to `` false ``.
79+ project name itself.
7880* ``logo_text_align ``: Which CSS ``text-align `` value to use for logo text
7981 (if there is any.)
8082* ``body_text_align ``: Which CSS ``text-align `` value to use for body text
8183 (if there is any.)
8284* ``description ``: Text blurb about your project, to appear under the logo.
8385* ``description_font_style ``: Which CSS ``font-style `` to use for description
84- text. Defaults to `` normal ``.
86+ text.
8587* ``github_user ``, ``github_repo ``: Used by ``github_button `` and
8688 ``github_banner `` (see below); does nothing if both of those are set to
8789 ``false ``.
88- * ``github_button ``: ``true `` or ``false `` (default: ``true ``) - whether to
89- link to your Github.
90+ * ``github_button ``: ``true `` or ``false `` - whether to link to your Github.
9091
9192 * If ``true ``, requires that you set ``github_user `` and ``github_repo ``.
92- * See also these other related options, which behave as described in
93- `Github Buttons' documentation
93+ * There are also the `` github_type `` and `` github_count `` options, which
94+ behave as described in `Github Buttons' documentation
9495 <https://ghbtns.com> `_:
9596
96- * ``github_type ``: Defaults to ``watch ``.
97- * ``github_count ``: Defaults to ``true ``.
98-
99- * ``github_banner ``: ``true `` or ``false `` (default: ``false ``) - whether to
100- apply a 'Fork me on Github' banner in the top right corner of the page.
97+ * ``github_banner ``: ``true `` or ``false `` - whether to apply a 'Fork me on
98+ Github' banner in the top right corner of the page.
10199
102100 * If ``true ``, requires that you set ``github_user `` and ``github_repo ``.
103101 * May also submit a string file path (as with ``logo ``, relative to
104102 ``$PROJECT/_static/ ``) to be used as the banner image instead of the
105103 default.
106104
107105* ``badge_branch ``: Set which branch is used in Travis, CodeCov, etc badges.
108- Defaults to ``master ``.
109-
110106* ``travis_button ``: ``true ``, ``false `` or a Github-style ``"account/repo" ``
111107 string - used to display a `Travis-CI <https://travis-ci.org >`_ build status
112108 button in the sidebar. If ``true ``, uses your ``github_(user|repo) ``
113- settings; defaults to `` false. ``
109+ settings.
114110* ``codecov_button ``: ``true ``, ``false `` or a Github-style ``"account/repo" ``
115111 string - used to display a `Codecov <https://codecov.io >`_ build status
116112 button in the sidebar. If ``true ``, uses your ``github_(user|repo) ``
117- settings; defaults to `` false. ``
113+ settings.
118114* ``gratipay_user ``: Set to your `Gratipay <https://gratipay.com >`_ username
119115 if you want a Gratipay 'Donate' section in your sidebar.
120116
@@ -154,17 +150,14 @@ Variables and feature toggles
154150 secondary navigation elements are hidden or displayed. Defaults to ``false ``
155151 since on many sites these elements are superfluous.
156152* ``page_width ``: CSS width specifier controlling default content/page width.
157- Defaults to ``940px ``.
158153* ``sidebar_width ``: CSS width specifier controlling default sidebar width.
159- Defaults to ``220px ``.
160154* ``fixed_sidebar ``: Makes the sidebar 'fixed' or pinned in place, so that the
161155 main body of the page scrolls but the sidebar remains visible. (Applies only
162- to desktop window sizes; the mobile view is unaffected.) Defaults to
163- ``false ``.
164- * ``show_relbars ``: ``true `` or ``false ``, defaults to ``false `` - used to
165- display *next * and *previous * links above and below the main page content. If
166- you only want to display one, this setting can be further overridden through
167- the ``show_relbar_top `` and ``show_relbar_bottom `` settings.
156+ to desktop window sizes; the mobile view is unaffected.)
157+ * ``show_relbars ``: ``true `` or ``false `` - used to display *next * and
158+ *previous * links above and below the main page content. If you only want to
159+ display one, this setting can be further overridden through the
160+ ``show_relbar_top `` and ``show_relbar_bottom `` settings.
168161
169162Style colors
170163------------
@@ -183,52 +176,49 @@ colorscheme. The more granular settings can be used to override as needed.
183176* ``footer_text ``: Footer text (includes links.)
184177* ``link ``: Non-hovered body links.
185178* ``link_hover ``: Body links, hovered.
186- * ``sidebar_header ``: Sidebar headers. Defaults to `` gray_1 ``.
179+ * ``sidebar_header ``: Sidebar headers.
187180* ``sidebar_text ``: Sidebar paragraph text.
188181* ``sidebar_link ``: Sidebar links (there is no hover variant.) Applies to
189- both header & text links. Defaults to `` gray_1 ``.
182+ both header & text links.
190183* ``sidebar_link_underscore ``: Sidebar links' underline (technically a
191184 bottom-border).
192185* ``sidebar_search_button ``: Background color of the search field's 'Go'
193186 button.
194187* ``sidebar_list ``: Foreground color of sidebar list bullets & unlinked text.
195- * ``sidebar_hr ``: Color of sidebar horizontal rule dividers. Defaults to
196- ``gray_3 ``.
188+ * ``sidebar_hr ``: Color of sidebar horizontal rule dividers.
197189* ``anchor ``: Foreground color of section anchor links (the 'paragraph'
198190 symbol that shows up when you mouseover page section headers.)
199191* ``anchor_hover_fg ``: Foreground color of section anchor links (as above)
200- when moused over. Defaults to `` gray_1 ``.
192+ when moused over.
201193* ``anchor_hover_bg ``: Background color of above.
202- * ``note_bg ``: Background of ``.. note:: `` blocks. Defaults to `` gray_2 ``.
194+ * ``note_bg ``: Background of ``.. note:: `` blocks.
203195* ``note_border ``: Border of same.
204- * ``seealso_bg ``: Background of ``.. seealso:: `` blocks. Defaults to
205- ``gray_2 ``.
196+ * ``seealso_bg ``: Background of ``.. seealso:: `` blocks.
206197* ``seealso_border ``: Border of same.
207- * ``warn_bg ``: Background of ``.. warn:: `` blocks. Defaults to `` pink_1 ``.
208- * ``warn_border ``: Border of same. Defaults to `` pink_2 ``.
198+ * ``warn_bg ``: Background of ``.. warn:: `` blocks.
199+ * ``warn_border ``: Border of same.
209200* ``footnote_bg ``: Background of footnote blocks.
210- * ``footnote_border ``: Border of same. Defaults to `` gray_2 ``.
201+ * ``footnote_border ``: Border of same.
211202* ``pre_bg ``: Background of preformatted text blocks (including code
212- snippets.) Defaults to `` gray_2 ``.
203+ snippets.)
213204* ``narrow_sidebar_bg ``: Background of 'sidebar' when narrow window forces
214205 it to the bottom of the page.
215206* ``narrow_sidebar_fg ``: Text color of same.
216- * ``narrow_sidebar_link ``: Link color of same. Defaults to `` gray_3 ``.
207+ * ``narrow_sidebar_link ``: Link color of same.
217208* ``code_highlight ``: Color of highlight when using ``:emphasize-lines: `` in a code block.
218209* ``relbar_border ``: Color of border between bar holding *next * and *previous *
219- links, and the rest of the page content. Defaults to `` gray_2 ``.
210+ links, and the rest of the page content.
220211
221212Fonts
222213-----
223214
224- * ``font_family ``: Font family of body text. Defaults to ``'goudy old style',
225- 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif ``.
226- * ``font_size ``: Font size of body text. Defaults to ``17px `` (``1.0625em ``).
215+ * ``font_family ``: Font family of body text.
216+ * ``font_size ``: Font size of body text.
227217* ``head_font_family ``: Font family of headings. Defaults to ``'Garamond',
228218 'Georgia', serif ``.
229- * ``code_font_size ``: Font size of code block text. Defaults to `` 0.9em ``.
219+ * ``code_font_size ``: Font size of code block text.
230220* ``code_font_family ``: Font family of code block text. Defaults to
231221 ``'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono',
232222 monospace ``.
233- * ``caption_font_size ``: Font size of caption block text. Defaults to `` font-size ``.
234- * ``caption_font_family ``: Font family of caption block text. Defaults to `` font-family ``.
223+ * ``caption_font_size ``: Font size of caption block text.
224+ * ``caption_font_family ``: Font family of caption block text.
0 commit comments