8000 DOC fix some whats_new sphinx warning. (#15288) · rasbt/scikit-learn@9e08b14 · GitHub
[go: up one dir, main page]
Skip to content

Commit 9e08b14

Browse files
cmarmoadrinjalali
cmarmo
authored and
adrinjalali
committed
DOC fix some whats_new sphinx warning. (scikit-learn#15288)
* Suggestion for whats_new warning solution. * DOC Adds labels * Address comments and fix new sphinx warnings. * Move lgend file in whats_new directory.
1 parent 37ac3fd commit 9e08b14

File tree

5 files changed

+23
-28
lines changed

5 files changed

+23
-28
lines changed

‎doc/templates/index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -158,15 +158,15 @@ <h4 class="sk-landing-call-header">News</h4>
158158
</li>
159159
<li><strong>Scikit-learn from 0.21 requires Python 3.5 or greater.</strong>
160160
</li>
161-
<li><strong>July 2019.</strong> scikit-learn 0.21.3 (<a href="whats_new.html#version-0-21-3">Changelog</a>) and 0.20.4 (<a href="whats_new.html#version-0-20-4">Changelog</a>) are available for download.
161+
<li><strong>July 2019.</strong> scikit-learn 0.21.3 (<a href="whats_new/v0.21.html#version-0-21-3">Changelog</a>) and 0.20.4 (<a href="whats_new/v0.20.html#version-0-20-4">Changelog</a>) are available for download.
162162
</li>
163-
<li><strong>May 2019.</strong> scikit-learn 0.21.0 to 0.21.2 are available for download (<a href="whats_new.html#version-0-21">Changelog</a>).
163+
<li><strong>May 2019.</strong> scikit-learn 0.21.0 to 0.21.2 are available for download (<a href="whats_new/v0.21.html#version-0-21-2">Changelog</a>).
164164
</li>
165-
<li><strong>March 2019.</strong> scikit-learn 0.20.3 is available for download (<a href="whats_new.html#version-0-20-3">Changelog</a>).
165+
<li><strong>March 2019.</strong> scikit-learn 0.20.3 is available for download (<a href="whats_new/v0.20.html#version-0-20-3">Changelog</a>).
166166
</li>
167-
<li><strong>September 2018.</strong> scikit-learn 0.20.0 is available for download (<a href="whats_new.html#version-0-20-0">Changelog</a>).
167+
<li><strong>September 2018.</strong> scikit-learn 0.20.0 is available for download (<a href="whats_new/v0.20.html#version-0-20-0">Changelog</a>).
168168
</li>
169-
<li><strong>July 2018.</strong> scikit-learn 0.19.2 is available for download (<a href="whats_new.html#version-0-19">Changelog</a>).
169+
<li><strong>July 2018.</strong> scikit-learn 0.19.2 is available for download (<a href="whats_new/v0.19.html#version-0-19-2">Changelog</a>).
170170
</li>
171171
<li><strong>July 2017.</strong> scikit-learn 0.19.0 is available for download (<a href="whats_new/v0.19.html#version-0-19">Changelog</a>).
172172
</li>

‎doc/whats_new.rst

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,19 @@
11
.. currentmodule:: sklearn
2-
.. include:: includes/big_toc_css.rst
32
.. include:: whats_new/_contributors.rst
43

54
Release History
65
===============
76

8-
Release notes for current and recent releases are detailed on this page, with
9-
:ref:`previous releases <previous_releases_whats_new>` linked below.
7+
Release notes for all scikit-learn releases are linked in this this page.
108

119
**Tip:** `Subscribe to scikit-learn releases <https://libraries.io/pypi/scikit-learn>`__
1210
on libraries.io to be notified when new versions are released.
1311

14-
Legend for changelogs
15-
---------------------
16-
17-
- |MajorFeature|: something big that you couldn't do before.
18-
- |Feature|: something that you couldn't do before.
19-
- |Efficiency|: an existing feature now may not require as much computation or
20-
memory.
21-
- |Enhancement|: a miscellaneous minor improvement.
22-
- |Fix|: something that previously didn't work as documentated -- or according
23-
to reasonable expectations -- should now work.
24-
- |API|: you will need to change your code to have the same effect in the
25-
future; or a feature will be removed in the future.
26-
27-
.. include:: whats_new/v0.22.rst
28-
.. include:: whats_new/v0.21.rst
29-
30-
.. _previous_releases_whats_new:
31-
32-
Previous Releases
33-
=================
3412
.. toctree::
3513
:maxdepth: 1
3614

15+
Version 0.22 <whats_new/v0.22.rst>
16+
Version 0.21 <whats_new/v0.21.rst>
3717
Version 0.20 <whats_new/v0.20.rst>
3818
Version 0.19 <whats_new/v0.19.rst>
3919
Version 0.18 <whats_new/v0.18.rst>

‎doc/whats_new/changelog_legend.inc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Legend for changelogs
2+
---------------------
3+
4+
- |MajorFeature|: something big that you couldn't do before.
5+
- |Feature|: something that you couldn't do before.
6+
- |Efficiency|: an existing feature now may not require as much computation or
7+
memory.
8+
- |Enhancement|: a miscellaneous minor improvement.
9+
- |Fix|: something that previously didn't work as documentated -- or according
10+
to reasonable expectations -- should now work.
11+
- |API|: you will need to change your code to have the same effect in the
12+
future; or a feature will be removed in the future.

‎doc/whats_new/v0.21.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
Version 0.21.3
88
==============
99

10+
.. include:: changelog_legend.inc
11+
1012
**July 30, 2019**
1113

1214
Changed models

‎doc/whats_new/v0.22.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ For a short description of the main highlights of the release, please
1313
refer to
1414
:ref:`sphx_glr_auto_examples_release_highlights_plot_release_highlights_0_22_0.py`.
1515

16+
.. include:: changelog_legend.inc
1617

1718
Clear definition of the public API
1819
----------------------------------

0 commit comments

Comments
 (0)
0