Skip to content

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

Merged
merged 55 commits into from
Nov 14, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
ed7380f
DOC: Change release and whatsnew
TomAugspurger Jun 21, 2018
721a41e
remove old file
TomAugspurger Jun 22, 2018
8fb4fc7
wip
TomAugspurger Jun 25, 2018
d99c1da
DOC
TomAugspurger Jun 25, 2018
583320c
move
TomAugspurger Jun 25, 2018
f6b1ee2
directive
TomAugspurger Jun 25, 2018
33521c8
Added directive
TomAugspurger Jun 26, 2018
7cc8ca2
Updated announce
TomAugspurger Jun 26, 2018
fbc6bc6
updated conf
TomAugspurger Jun 26, 2018
888306b
Added ref
TomAugspurger Jun 26, 2018
229d800
re-add rst2jinja
TomAugspurger Jun 26, 2018
9cc76b0
whatsnew contributors
TomAugspurger Jun 27, 2018
447a3f4
headings
TomAugspurger Jun 28, 2018
91ae6c0
rename to rst
TomAugspurger Jun 28, 2018
af1551f
fixups
TomAugspurger Jun 28, 2018
47a868a
Merge remote-tracking branch 'upstream/master' into doc-release-autom…
TomAugspurger Jun 28, 2018
bd723e3
Fixed warning
TomAugspurger Jun 28, 2018
3ad4a66
fixup warning
TomAugspurger Jun 28, 2018
7669ce5
Fixups
TomAugspurger Jun 28, 2018
1114bb7
Updates
TomAugspurger Jun 28, 2018
bd439c9
remove updates
TomAugspurger Jun 28, 2018
58e53b8
Merge remote-tracking branch 'upstream/master' into doc-release-autom…
TomAugspurger Jun 29, 2018
59bfdd6
Merge branch 'master' into doc-release-automation
TomAugspurger Jul 5, 2018
56ae2a6
fixup! Merge branch 'master' into doc-release-automation
TomAugspurger Jul 5, 2018
0fe6baf
types
TomAugspurger Jul 5, 2018
64a745c
headings
TomAugspurger Jul 5, 2018
526d0c5
Docs
TomAugspurger Jul 5, 2018
6fdb7f7
Merge remote-tracking branch 'upstream/master' into doc-release-autom…
TomAugspurger Oct 3, 2018
7e4ec6e
update new files
TomAugspurger Oct 3, 2018
6103af6
style
TomAugspurger Oct 4, 2018
e28dfe1
new pages
TomAugspurger Oct 4, 2018
38859b5
remove old whatsnew
TomAugspurger Oct 4, 2018
a88a24a
revert dtypes
TomAugspurger Oct 4, 2018
b4545bf
style
TomAugspurger Oct 4, 2018
d9b0480
moves
TomAugspurger Oct 4, 2018
d2bc58a
update
TomAugspurger Nov 12, 2018
ce1c134
Minor fixups
TomAugspurger Nov 12, 2018
0922b14
contributed patches
TomAugspurger Nov 12, 2018
5f7ca10
Merge remote-tracking branch 'upstream/master' into doc-release-autom…
TomAugspurger Nov 12, 2018
86fbb6c
Added gitpython
TomAugspurger Nov 12, 2018
9939332
Merge remote-tracking branch 'upstream/master' into doc-release-autom…
TomAugspurger Nov 13, 2018
8b1f91b
exclude whatsnew for now
TomAugspurger Nov 13, 2018
99a2fb6
update contributing
TomAugspurger Nov 13, 2018
33ea13b
doc lint
TomAugspurger Nov 13, 2018
e7d7f1d
fixup issue link
TomAugspurger Nov 13, 2018
9d8c6f9
update headers
TomAugspurger Nov 13, 2018
69be4b5
Merge remote-tracking branch 'upstream/master' into doc-release-autom…
TomAugspurger Nov 13, 2018
3d9215d
fixup! Merge remote-tracking branch 'upstream/master' into doc-releas…
TomAugspurger Nov 13, 2018
61334d0
header
TomAugspurger Nov 13, 2018
1d8ad73
Merge remote-tracking branch 'upstream/master' into doc-release-autom…
TomAugspurger Nov 13, 2018
1527aab
Merge remote-tracking branch 'upstream/master' into doc-release-autom…
TomAugspurger Nov 14, 2018
8a7e3e7
build inside repo
TomAugspurger Nov 14, 2018
34be519
Merge remote-tracking branch 'upstream/master' into doc-release-autom…
TomAugspurger Nov 14, 2018
059e0bd
release -> version
TomAugspurger Nov 14, 2018
bc5d49e
Merge remote-tracking branch 'upstream/master' into doc-release-autom…
TomAugspurger Nov 14, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,5 @@ doc/build/html/index.html
# Windows specific leftover:
doc/tmp.sv
doc/source/styled.xlsx
doc/source/templates/
env/
doc/source/savefig/
56 changes: 54 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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([

Expand All @@ -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 -----------------------------------------------

Expand Down Expand Up @@ -120,7 +122,10 @@
templates_path = ['../_templates']

# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = [
'.rst',
'.txt',
Copy link
Contributor Author

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.

Copy link
Member

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 ?

]

# The encoding of source files.
source_encoding = 'utf-8'
Expand Down Expand Up @@ -298,8 +303,39 @@
for page in moved_api_pages
}


common_imports = """\
Copy link
Contributor Author

Choose a reason for hiding this comment

The 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 whatsnew/v0.x.x.txt, as they are no longer literally included below this. Usage is just {{ common_imports }}

.. 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
"""


def get_contributors(start, end):

return announce.build_string('{}..{}'.format(start, end), None)


contributors = {
'v0.24.0': announce.build_string('v0.23.1..HEAD'),
'v0.23.2': announce.build_string('v0.23.1..HEAD'),
'v0.23.1': announce.build_string('v0.23.0..v0.23.1'),
'v0.23.0': announce.build_string('v0.22.0..v0.23.0'),
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is run every time we build the docs. It'll probably be run even for single page / docstring ones. I was concerned it would take a while, but it's surprisingly fast.

Once I finish the rest of the whatsnew, I'll time it again and look into ways of speeding it up if is a problem.



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.
Expand Down Expand Up @@ -649,7 +685,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':
Copy link
Contributor Author

Choose a reason for hiding this comment

The 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)
Expand Down
4 changes: 2 additions & 2 deletions doc/source/index.rst.template
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Copy link
Contributor Author

Choose a reason for hiding this comment

The 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
Expand Down Expand Up @@ -159,5 +159,5 @@ See the package overview for more detail about what's in the library.
developer
internals
extending
release
releases
{% endif -%}
34 changes: 34 additions & 0 deletions doc/source/release_index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. _release:

.. currentmodule:: pandas

.. ipython:: python
:suppress:

import pandas as pd
import numpy as np
np.random.seed(123456)
np.set_printoptions(precision=4, suppress=True)
import matplotlib.pyplot as plt
plt.close('all')

pd.options.display.max_rows=15
import pandas.util.testing as tm

*************
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: 1

/source/whatsnew/v0.23.2.txt
whatsnew/v0.23.1.txt
whatsnew/v0.23.0.txt
193 changes: 193 additions & 0 deletions doc/source/releases.rst
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
Loading