22Changelog
33=========
44
5- * :release: `0.7.11 <2018-06-18> `
6- * :bug: `73 ` Clean up some problematic font issues:
5+ - :release: `0.7.11 <2018-06-18> `
6+ - :bug: `73 ` Clean up some problematic font issues:
77
88 - Remove the outright broken Goudy Old Style, plus other mostly Adobe-only
99 fonts, from the ``font_family `` config setting; it is now simply ``Georgia,
@@ -32,97 +32,97 @@ Changelog
3232 As seen in the note above, you can **always ** override the new defaults to
3333 go back to the old behavior, using your config file.
3434
35- * :feature: `18 backported ` (via :issue: `101 `) Add optional *next * and
35+ - :feature: `18 backported ` (via :issue: `101 `) Add optional *next * and
3636 *previous * links at the top and bottom of page content. Use theme option
3737 ``show_relbars `` to enable these. Credit: William Minchin.
38- * :support: `- backported ` Miscellaneous project maintenance updates such as
38+ - :support: `- backported ` Miscellaneous project maintenance updates such as
3939 adding to Travis CI and enforcing the use of ``flake8 ``.
40- * :feature: `110 backported ` Add ``badge_branch `` option allowing
40+ - :feature: `110 backported ` Add ``badge_branch `` option allowing
4141 configurability of which specific Git branch the Travis, Codecov, etc buttons
4242 default to. Credit: ``@TitanSnow ``.
43- * :support: `111 backported ` Add setuptools-level entrypoint for improved theme
43+ - :support: `111 backported ` Add setuptools-level entrypoint for improved theme
4444 distribution compatibility. Thanks to Aaron Carlisle for the patch.
45- * :release: `0.7.10 <2017-02-28> `
46- * :bug: `32 ` Update styling of various block-level elements such as admonitions
45+ - :release: `0.7.10 <2017-02-28> `
46+ - :bug: `32 ` Update styling of various block-level elements such as admonitions
4747 (``.. note:: ``, ``.. warning:: ``, etc) and code blocks (``.. code:: ``) so
4848 they are no longer 'dedented' outside the main column of text they're
4949 embedded in. This is both a stylistic change and a bugfix, since e.g. nesting
5050 code blocks *within * note blocks looks actively broken. Thanks to Takayuki
5151 Shimizukawa for the report.
52- * :bug: `96 ` ``admonition_xref `` had a template typo preventing it from
52+ - :bug: `96 ` ``admonition_xref `` had a template typo preventing it from
5353 receiving styling; this has been fixed. Credit: Kenzie Togami.
54- * :bug: `95 ` Independently ran across
54+ - :bug: `95 ` Independently ran across
5555 `sphinx-doc/sphinx#3276 <https://github.com/sphinx-doc/sphinx/issues/3276 >`_,
5656 namely that parameter lists become squashed together if one is running on
5757 Sphinx 1.4.x. While that fix was merged in Sphinx itself, we felt it prudent
5858 to include it in our own stylesheet as well, for immediate relief.
59- * :release: `0.7.9 <2016-07-25> `
60- * :feature: `6 ` (and :issue: `70 `, both via :issue: `84 `) Make all remaining
59+ - :release: `0.7.9 <2016-07-25> `
60+ - :feature: `6 ` (and :issue: `70 `, both via :issue: `84 `) Make all remaining
6161 hardcoded style colors configurable, plus related cleanup (such as improving
6262 differentiation of some admonition blocks such as ``warn `` and ``note ``,
6363 ensuring generic admonitions are left untouched, etc). Credit:
6464 ``@ShadowKyogre ``.
65- * :feature: `83 ` Expose Sphinx's toctree ``collapse `` option as the new
65+ - :feature: `83 ` Expose Sphinx's toctree ``collapse `` option as the new
6666 ``sidebar_collapse `` config option. Credit: Eric Holscher.
67- * :feature: `80 ` Add support for ``<link rel="canonical"> `` (i.e. canonical
67+ - :feature: `80 ` Add support for ``<link rel="canonical"> `` (i.e. canonical
6868 URLs). Thanks to Ben Gamari for the patch.
69- * :support: `7 ` Generate real documentation site, both because the README is
69+ - :support: `7 ` Generate real documentation site, both because the README is
7070 just too big now, and so we can `eat our own dog food
7171 <https://en.wikipedia.org/wiki/Eating_your_own_dog_food> `_.
72- * :release: `0.7.8 <2016-05-05> `
73- * #51 (via #67): Hide Github button if ``github_user `` and ``github_repo ``
72+ - :release: `0.7.8 <2016-05-05> `
73+ - #51 (via #67): Hide Github button if ``github_user `` and ``github_repo ``
7474 aren't set. This is necessary since ``github_button `` defaults to True.
7575 Thanks to Sam Whited for the report & Dmitry Shachnev for the patch.
76- * #75: Use SVG version of the Travis-CI button. Thanks to Sebastian Wiesner for
76+ - #75: Use SVG version of the Travis-CI button. Thanks to Sebastian Wiesner for
7777 the patch.
78- * #41: Update the Github buttons to use a newer linked image & change the link
78+ - #41: Update the Github buttons to use a newer linked image & change the link
7979 to their docs. Thanks to Tomi Hukkalainen.
80- * #45 (via #46) Tweak styling of nested bullet lists to prevent an issue where
80+ - #45 (via #46) Tweak styling of nested bullet lists to prevent an issue where
8181 they all collapse to the same indent level when viewed on smaller display
8282 sizes. Thanks to Bram Geron for catch & patch, and to Jochen Kupperschmidt
8383 for review/discussion.
84- * #44 (partial; via #57) Add an opt-in fixed sidebar behavior for users who
84+ - #44 (partial; via #57) Add an opt-in fixed sidebar behavior for users who
8585 prefer a sidebar that never scrolls out of view. Credit: Joe Cross.
86- * #61: Set a small-but-nonzero footnote width to work around a common browser
86+ - #61: Set a small-but-nonzero footnote width to work around a common browser
8787 display bug. Thanks to Konstantin Molchanov for catch & patch.
88- * #64: Add config options for font size and caption font size/family. Credit:
88+ - #64: Add config options for font size and caption font size/family. Credit:
8989 Marçal Solà.
90- * #78: Add custom stylesheet support. (This release will thus be the last to
90+ - #78: Add custom stylesheet support. (This release will thus be the last to
9191 merge simplistic style tweaks as feature toggles - only thorny CSS issues or
9292 actual template-related changes will be merged afterwards.)
93- * #65: Wrap the sidebar's "Navigation" header in Sphinx's translation helper so
93+ - #65: Wrap the sidebar's "Navigation" header in Sphinx's translation helper so
9494 it gets translated if possible. Thanks to ``@uralbash ``.
95- * #77: Fix image link styling to remove a bottom border which appears in some
95+ - #77: Fix image link styling to remove a bottom border which appears in some
9696 situations. Thanks to Eric Holscher for the patch & ``@barbara-sfx `` for the
9797 report.
98- * :release: `0.7.7 <2015-12-21> `
99- * Add some ``margin-bottom `` to ``table.field-list p `` so field lists (e.g.
98+ - :release: `0.7.7 <2015-12-21> `
99+ - Add some ``margin-bottom `` to ``table.field-list p `` so field lists (e.g.
100100 Python function parameter lists in docstrings) written as multiple
101101 paragraphs, look like actual paragraphs instead of all globbing together.
102- * Fix incorrect notes in README re: renamed ``github_button_* `` options - the
102+ - Fix incorrect notes in README re: renamed ``github_button_* `` options - the
103103 ``button_ `` was dropped but docs did not reflect this. Thanks to Nik Nyby.
104- * Fix ``sidebar_hr `` setting - stylesheet wasn't correctly referencing the
104+ - Fix ``sidebar_hr `` setting - stylesheet wasn't correctly referencing the
105105 right variable name. Thanks to Jannis Leidel.
106- * Allow configuring body text-align via ``body_text_align ``. Credit to Marçal
106+ - Allow configuring body text-align via ``body_text_align ``. Credit to Marçal
107107 Solà.
108- * Fix a handful of mismatched/unclosed HTML tags in the templates. Thanks to
108+ - Fix a handful of mismatched/unclosed HTML tags in the templates. Thanks to
109109 Marvin Pinto for catch & patch.
110- * Add `Codecov <https://codecov.io >`_ badge support to sidebar.
111- * :release: `0.7.6 <2015-06-22> `
112- * Update how ``setup.py `` handles the ``README.rst `` file - load it explicitly
110+ - Add `Codecov <https://codecov.io >`_ badge support to sidebar.
111+ - :release: `0.7.6 <2015-06-22> `
112+ - Update how ``setup.py `` handles the ``README.rst `` file - load it explicitly
113113 as UTF-8 so the changelog containing non-ASCII characters doesn't generate
114114 ``UnicodeDecodeError `` in terminal environments whose default encoding is not
115115 UTF-8 or other Unicode-compatible encodings. Thanks to Arun Persaud for the
116116 report and Max Tepkeev for the suggested fix.
117- * Fix left-margin & padding styling for code blocks within list-item elements,
117+ - Fix left-margin & padding styling for code blocks within list-item elements,
118118 making them consistent with earlier changes applied to top-level code blocks.
119- * Expose page & sidebar widths as theme options ``page_width `` and
119+ - Expose page & sidebar widths as theme options ``page_width `` and
120120 ``sidebar_width ``. Their defaults are the same as the previously static
121121 values.
122- * :release: `0.7.5 <2015-06-15> `
123- * Honor Sphinx's core ``html_show_copyright `` option when rendering page
122+ - :release: `0.7.5 <2015-06-15> `
123+ - Honor Sphinx's core ``html_show_copyright `` option when rendering page
124124 footer. Thanks to Marcin Wojdyr for the report.
125- * Pre-history versions of Alabaster attempted to remove the "related"
125+ - Pre-history versions of Alabaster attempted to remove the "related"
126126 sub-navigation (typically found as next/previous links in other themes) but
127127 this didn't work right for mobile-oriented styling.
128128
@@ -137,72 +137,72 @@ Changelog
137137 installs).
138138
139139 Thanks to Tomi Pieviläinen for the bug report.
140- * Update the "Fork me on Github" banner image to use an ``https:// `` URI so
140+ - Update the "Fork me on Github" banner image to use an ``https:// `` URI so
141141 sites hosted over HTTPS don't encounter mixed-content errors. Thanks to
142142 ``@nikolas `` for the patch.
143- * Remove an orphaned ``</li> `` from the footer 'show source' section. Credit to
143+ - Remove an orphaned ``</li> `` from the footer 'show source' section. Credit to
144144 Marcin Wojdyr.
145- * :release: `0.7.4 <2015-05-03> `
146- * Add ``code_highlight `` option (which includes general fixes to styling of
145+ - :release: `0.7.4 <2015-05-03> `
146+ - Add ``code_highlight `` option (which includes general fixes to styling of
147147 code blocks containing highlighted lines). Thanks to Steven Loria.
148- * :release: `0.7.3 <2015-03-20> `
149- * Hide ``shadow `` related styles on bibliography elements, in addition to the
148+ - :release: `0.7.3 <2015-03-20> `
149+ - Hide ``shadow `` related styles on bibliography elements, in addition to the
150150 earlier change re: ``border ``. Thanks again to Philippe Dessus.
151- * :release: `0.7.2 <2015-03-10> `
152- * Updated CSS stylesheets to apply monospace styling to both ``tt `` and
151+ - :release: `0.7.2 <2015-03-10> `
152+ - Updated CSS stylesheets to apply monospace styling to both ``tt `` and
153153 ``code `` elements, instead of just to ``tt ``. This addresses a change in HTML
154154 generation in Sphinx 1.3 while retaining support for Sphinx 1.2. Thanks to
155155 Eric Holscher for the heads up.
156- * :release: `0.7.1 <2015-02-27> `
157- * Finally add a changelog. To the README, for now, because a full doc site
156+ - :release: `0.7.1 <2015-02-27> `
157+ - Finally add a changelog. To the README, for now, because a full doc site
158158 isn't worthwhile just yet.
159- * Allow configuring a custom Github banner image (instead of simply toggling a
159+ - Allow configuring a custom Github banner image (instead of simply toggling a
160160 default on or off). Thanks to Nicola Iarocci for the original patch.
161- * Explicitly note Python version support in the README and ``setup.py ``.
162- * Update Github button image link to use the newly-available HTTPS version of
161+ - Explicitly note Python version support in the README and ``setup.py ``.
162+ - Update Github button image link to use the newly-available HTTPS version of
163163 the URL; this helps prevent errors on doc pages served via HTTPS. Thanks to
164164 Gustavo Narea for the report.
165- * Add control over the font size & family of code blocks. Credit to Steven
165+ - Add control over the font size & family of code blocks. Credit to Steven
166166 Loria.
167- * Allow control over font family of body text and headings. Thanks to Georg
167+ - Allow control over font family of body text and headings. Thanks to Georg
168168 Brandl.
169- * Stylize ``.. seealso:: `` blocks same as ``.. note:: `` blocks for
169+ - Stylize ``.. seealso:: `` blocks same as ``.. note:: `` blocks for
170170 consistency's sake (previously, ``.. seealso:: `` used the Sphinx default
171171 styling, which clashed). We may update these again later but for now, this is
172172 an improvement! Thanks again to Steven Loria.
173- * Allow control over CSS ``font-style `` for the site description/tagline
173+ - Allow control over CSS ``font-style `` for the site description/tagline
174174 element. Credit: Steven Loria.
175- * Add styling to disable default cell borders on ``.. bibliography:: ``
175+ - Add styling to disable default cell borders on ``.. bibliography:: ``
176176 directives' output. Thanks to Philippe Dessus for the report.
177- * :release: `0.6.2 <2014-11-25> `
178- * Make ``.. warn:: `` blocks have a pink background (instead of having no
177+ - :release: `0.6.2 <2014-11-25> `
178+ - Make ``.. warn:: `` blocks have a pink background (instead of having no
179179 background, which was apparently an oversight of the themes Alabaster is
180180 based on) and also make that color configurable.
181- * :release: `0.6.1 <2014-09-04> `
182- * Update Gittip support to acknowledge the service's rename to Gratipay.
183- * :release: `0.6.0 <2014-04-17> `
184- * Allow hiding the 'powered by' section of the footer.
185- * Fix outdated name in ``setup.py `` URL field.
186- * :release: `0.5.1 <2014-04-15> `
187- * Fix a bug in the new Travis support, re: its default value.
188- * :release: `0.5.0 <2014-04-09> `
189- * Add support for sidebar Travis status buttons.
190- * :release: `0.4.1 <2014-04-06> `
191- * Fix an inaccuracy in the description of ``logo_text_align ``.
192- * Update logo & text styling to be more sensible.
193- * :release: `0.4.0 <2014-04-06> `
194- * Add an option to allow un-hiding one's toctree.
195- * :release: `0.3.1 <2014-03-13> `
196- * Improved Python 3 compatibility.
197- * Update styling of changelog pages generated by `bitprophet/releases
181+ - :release: `0.6.1 <2014-09-04> `
182+ - Update Gittip support to acknowledge the service's rename to Gratipay.
183+ - :release: `0.6.0 <2014-04-17> `
184+ - Allow hiding the 'powered by' section of the footer.
185+ - Fix outdated name in ``setup.py `` URL field.
186+ - :release: `0.5.1 <2014-04-15> `
187+ - Fix a bug in the new Travis support, re: its default value.
188+ - :release: `0.5.0 <2014-04-09> `
189+ - Add support for sidebar Travis status buttons.
190+ - :release: `0.4.1 <2014-04-06> `
191+ - Fix an inaccuracy in the description of ``logo_text_align ``.
192+ - Update logo & text styling to be more sensible.
193+ - :release: `0.4.0 <2014-04-06> `
194+ - Add an option to allow un-hiding one's toctree.
195+ - :release: `0.3.1 <2014-03-13> `
196+ - Improved Python 3 compatibility.
197+ - Update styling of changelog pages generated by `bitprophet/releases
198198 <https://github.com/bitprophet/releases> `_.
199- * :release: `0.3.0 <2014-02-03> `
200- * Display Alabaster version in footers alongside Sphinx version (necessitating
199+ - :release: `0.3.0 <2014-02-03> `
200+ - Display Alabaster version in footers alongside Sphinx version (necessitating
201201 use of a mini Sphinx extension) plus other footer tweaks.
202- * :release: `0.2.0 <2014-01-28> `
203- * Allow control of logo replacement text's alignment.
204- * Add customized navigation sidebar element.
205- * Tweak page margins a bit.
206- * Add a 3rd level of medium-gray to the stylesheet & apply in a few places.
207- * :release: `0.1.0 <2013-12-31> `
208- * First tagged/PyPI'd version.
202+ - :release: `0.2.0 <2014-01-28> `
203+ - Allow control of logo replacement text's alignment.
204+ - Add customized navigation sidebar element.
205+ - Tweak page margins a bit.
206+ - Add a 3rd level of medium-gray to the stylesheet & apply in a few places.
207+ - :release: `0.1.0 <2013-12-31> `
208+ - First tagged/PyPI'd version.
0 commit comments