-
- Notifications
You must be signed in to change notification settings - Fork 19.3k
DOC: Change release and whatsnew #21599
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 4 commits
ed7380f 721a41e 8fb4fc7 d99c1da 583320c f6b1ee2 33521c8 7cc8ca2 fbc6bc6 888306b 229d800 9cc76b0 447a3f4 91ae6c0 af1551f 47a868a bd723e3 3ad4a66 7669ce5 1114bb7 bd439c9 58e53b8 59bfdd6 56ae2a6 0fe6baf 64a745c 526d0c5 6fdb7f7 7e4ec6e 6103af6 e28dfe1 38859b5 a88a24a b4545bf d9b0480 d2bc58a ce1c134 0922b14 5f7ca10 86fbb6c 9939332 8b1f91b 99a2fb6 33ea13b e7d7f1d 9d8c6f9 69be4b5 3d9215d 61334d0 1d8ad73 1527aab 8a7e3e7 34be519 059e0bd bc5d49e File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| | @@ -40,6 +40,7 @@ | |
| # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
| # sys.path.append(os.path.abspath('.')) | ||
| sys.path.insert(0, os.path.abspath('../sphinxext')) | ||
| sys.path.insert(0, os.path.abspath('../../scripts')) | ||
| | ||
| sys.path.extend([ | ||
| | ||
| | @@ -53,6 +54,7 @@ | |
| # numpydoc is available in the sphinxext directory, and can't be imported | ||
| # until sphinxext is available in the Python path | ||
| from numpydoc.docscrape import NumpyDocString | ||
| import announce | ||
| | ||
| # -- General configuration ----------------------------------------------- | ||
| | ||
| | @@ -120,7 +122,10 @@ | |
| templates_path = ['../_templates'] | ||
| | ||
| # The suffix of source filenames. | ||
| source_suffix = '.rst' | ||
| source_suffix = [ | ||
| '.rst', | ||
| '.txt', | ||
| ] | ||
| | ||
| # The encoding of source files. | ||
| source_encoding = 'utf-8' | ||
| | @@ -298,8 +303,94 @@ | |
| for page in moved_api_pages | ||
| } | ||
| | ||
| | ||
| common_imports = """\ | ||
| Contributor Author There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Previously we had this at the top of whatsnew.rst. Now it has to be in every | ||
| .. currentmodule:: pandas | ||
| | ||
| .. ipython:: python | ||
| :suppress: | ||
| | ||
| import numpy as np | ||
| from pandas import * | ||
| import pandas as pd | ||
| randn = np.random.randn | ||
| np.set_printoptions(precision=4, suppress=True) | ||
| options.display.max_rows = 15 | ||
| """ | ||
| | ||
| import re | ||
| import git | ||
| | ||
| xpr = re.compile(r'^v(\d+)\.(\d+)\.(\d+)$') | ||
| repo = git.Repo('..') | ||
| tags = [x.name for x in repo.tags if xpr.match(str(x))] | ||
| versions = sorted(zip(tags, | ||
| [tuple(map(int, xpr.match(x).groups())) for x in tags]), | ||
| key=lambda x: x[1]) | ||
| ||
| | ||
| | ||
| def get_prior(versions, k): | ||
| if 'k'.endswith('0'): | ||
| return | ||
| | ||
| | ||
| contributors = { | ||
| 'v0.4.0': announce.build_string('v0.3.0..v0.4.0'), | ||
| 'v0.4.1': announce.build_string('v0.4.0..v0.4.1'), | ||
| 'v0.4.2': announce.build_string('v0.4.1..v0.4.2'), | ||
| 'v0.4.3': announce.build_string('v0.4.2..v0.4.3'), | ||
| 'v0.5.0': announce.build_string('v0.4.0..v0.5.0'), | ||
| 'v0.6.0': announce.build_string('v0.5.0..v0.6.0'), | ||
| 'v0.6.1': announce.build_string('v0.6.0..v0.6.1'), | ||
| 'v0.7.0': announce.build_string('v0.6.0..v0.7.0'), | ||
| 'v0.7.1': announce.build_string('v0.7.0..v0.7.1'), | ||
| 'v0.7.2': announce.build_string('v0.7.1..v0.7.2'), | ||
| 'v0.7.3': announce.build_string('v0.7.2..v0.7.3'), | ||
| 'v0.8.0': announce.build_string('v0.7.0..v0.8.0'), | ||
| 'v0.8.1': announce.build_string('v0.8.0..v0.8.1'), | ||
| 'v0.9.0': announce.build_string('v0.8.1..v0.9.0'), | ||
| 'v0.9.1': announce.build_string('v0.9.0..v0.9.1'), | ||
| 'v0.10.0': announce.build_string('v0.9.0..v0.10.0'), | ||
| 'v0.10.1': announce.build_string('v0.10.0..v0.10.1'), | ||
| 'v0.11.0': announce.build_string('v0.10.0..v0.11.0'), | ||
| 'v0.12.0': announce.build_string('v0.11.0..v0.12.0'), | ||
| 'v0.13.0': announce.build_string('v0.12.0..v0.13.0'), | ||
| 'v0.13.1': announce.build_string('v0.13.0..v0.13.1'), | ||
| 'v0.14.0': announce.build_string('v0.13.0..v0.14.0'), | ||
| 'v0.14.1': announce.build_string('v0.14.0..v0.14.1'), | ||
| 'v0.15.0': announce.build_string('v0.14.0..v0.15.0'), | ||
| 'v0.15.1': announce.build_string('v0.15.0..v0.15.1'), | ||
| 'v0.15.2': announce.build_string('v0.15.1..v0.15.2'), | ||
| 'v0.16.0': announce.build_string('v0.15.0..v0.16.0'), | ||
| 'v0.16.1': announce.build_string('v0.10.0..v0.16.1'), | ||
| 'v0.16.2': announce.build_string('v0.16.1..v0.16.2'), | ||
| 'v0.17.0': announce.build_string('v0.16.2..v0.17.0'), | ||
| 'v0.17.1': announce.build_string('v0.17.0..v0.17.1'), | ||
| 'v0.18.0': announce.build_string('v0.10.0..v0.18.0'), | ||
| 'v0.18.1': announce.build_string('v0.10.0..v0.18.1'), | ||
| 'v0.19.0': announce.build_string('v0.10.0..v0.19.0'), | ||
| 'v0.19.1': announce.build_string('v0.10.0..v0.19.1'), | ||
| 'v0.19.2': announce.build_string('v0.10.0..v0.19.2'), | ||
| 'v0.20.0': announce.build_string('v0.10.0..v0.20.0'), | ||
| 'v0.20.1': announce.build_string('v0.10.0..v0.20.1'), | ||
| 'v0.20.2': announce.build_string('v0.10.0..v0.20.2'), | ||
| 'v0.20.3': announce.build_string('v0.10.0..v0.20.3'), | ||
| 'v0.21.0': announce.build_string('v0.10.0..v0.21.0'), | ||
| 'v0.21.1': announce.build_string('v0.10.0..v0.21.1'), | ||
| 'v0.22.0': announce.build_string('v0.10.0..v0.22.0'), | ||
| 'v0.22.0': announce.build_string('v0.22.0..v0.23.0'), | ||
| ||
| 'v0.23.0': announce.build_string('v0.22.0..v0.23.0'), | ||
| 'v0.23.1': announce.build_string('v0.23.0..v0.23.1'), | ||
| 'v0.23.2': announce.build_string('v0.23.1..HEAD'), | ||
| 'v0.24.0': announce.build_string('v0.23.1..HEAD'), | ||
| | ||
| } | ||
| ||
| | ||
| | ||
| html_context = { | ||
| 'redirects': {old: new for old, new in moved_api_pages} | ||
| 'redirects': {old: new for old, new in moved_api_pages}, | ||
| 'common_imports': common_imports, | ||
| 'contributors': contributors, | ||
| } | ||
| | ||
| # If false, no module index is generated. | ||
| | @@ -649,7 +740,23 @@ def process_class_docstrings(app, what, name, obj, options, lines): | |
| ] | ||
| | ||
| | ||
| def rstjinja(app, docname, source): | ||
| """ | ||
| Render our pages as a jinja template for fancy templating goodness. | ||
| """ | ||
| # http://ericholscher.com/blog/2016/jul/25/integrating-jinja-rst-sphinx/ | ||
| # Make sure we're outputting HTML | ||
| if app.builder.format != 'html': | ||
| Contributor Author There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hmm I should look into what happens for PDF. We should be able to handle it just fine. | ||
| return | ||
| src = source[0] | ||
| rendered = app.builder.templates.render_string( | ||
| src, app.config.html_context | ||
| ) | ||
| source[0] = rendered | ||
| | ||
| | ||
| def setup(app): | ||
| app.connect("source-read", rstjinja) | ||
| app.connect("autodoc-process-docstring", remove_flags_docstring) | ||
| app.connect("autodoc-process-docstring", process_class_docstrings) | ||
| app.add_autodocumenter(AccessorDocumenter) | ||
| | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| | @@ -118,7 +118,7 @@ See the package overview for more detail about what's in the library. | |
| {{ single_doc }} | ||
| {% endif -%} | ||
| {% if not single_doc -%} | ||
| whatsnew | ||
| What's New <whatsnew/v0.24.0> | ||
| Contributor Author There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We'll update this as part of the post-release process. | ||
| install | ||
| contributing | ||
| overview | ||
| | @@ -159,5 +159,5 @@ See the package overview for more detail about what's in the library. | |
| developer | ||
| internals | ||
| extending | ||
| release | ||
| releases | ||
| {% endif -%} | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| .. _release: | ||
| | ||
| ************* | ||
| Release Notes | ||
| ************* | ||
| | ||
| This is the list of changes to pandas between each release. For full details, | ||
| see the commit logs at http://github.com/pandas-dev/pandas. For install and | ||
| upgrade instructions, see :ref:`install`. | ||
| | ||
| 0.23 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.23.2 | ||
| whatsnew/v0.23.1 | ||
| whatsnew/v0.23.0 | ||
| | ||
| 0.22 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.22.0 | ||
| | ||
| 0.21 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.21.0.txt | ||
| whatsnew/v0.21.1.txt | ||
| | ||
| 0.20 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.20.0.txt | ||
| whatsnew/v0.20.2.txt | ||
| whatsnew/v0.20.3.txt | ||
| | ||
| 0.19 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.19.0.txt | ||
| whatsnew/v0.19.1.txt | ||
| whatsnew/v0.19.2.txt | ||
| | ||
| 0.18 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.18.0.txt | ||
| whatsnew/v0.18.1.txt | ||
| | ||
| 0.17 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.17.0.txt | ||
| whatsnew/v0.17.1.txt | ||
| | ||
| 0.16 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.16.0.txt | ||
| whatsnew/v0.16.1.txt | ||
| whatsnew/v0.16.2.txt | ||
| | ||
| 0.15 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.15.0.txt | ||
| whatsnew/v0.15.1.txt | ||
| whatsnew/v0.15.2.txt | ||
| | ||
| 0.14 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.14.0.txt | ||
| whatsnew/v0.14.1.txt | ||
| | ||
| 0.13 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.13.0.txt | ||
| whatsnew/v0.13.1.txt | ||
| | ||
| 0.12 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.12.0.txt | ||
| | ||
| 0.11 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.11.0.txt | ||
| | ||
| 0.10 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.10.0.txt | ||
| whatsnew/v0.10.1.txt | ||
| | ||
| 0.9 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.9.0.txt | ||
| whatsnew/v0.9.1.txt | ||
| | ||
| 0.8 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.8.0.txt | ||
| whatsnew/v0.8.1.txt | ||
| | ||
| 0.7 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.7.0.txt | ||
| whatsnew/v0.7.1.txt | ||
| whatsnew/v0.7.2.txt | ||
| whatsnew/v0.7.3.txt | ||
| | ||
| 0.6 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| | ||
| whatsnew/v0.6.0.txt | ||
| whatsnew/v0.6.1.txt | ||
| | ||
| 0.5 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| | ||
| whatsnew/v0.5.0.txt | ||
| | ||
| 0.4 release | ||
| ------------ | ||
| | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| | ||
| whatsnew/v0.4.x.txt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
required so that the whatsnew files can be included in the toctree.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there actually a reason they are not *.rst ?