Skip to content

Doc more release updates #13492

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.

Sign up for GitHub

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 4 commits into from
Feb 24, 2019
Merged

Doc more release updates #13492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c242800
DOC: fix memleak test execution + note backend_driver is broken
tacaswell Feb 23, 2019
fa16e96
DOC: add missing popd
tacaswell Feb 23, 2019
3add366
DOC: change not to backup github stats + add glob toc
tacaswell Feb 23, 2019
758b071
DOC: add note about merging up the docs branch.
tacaswell Feb 23, 2019
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
21 changes: 17 additions & 4 deletions doc/devel/release_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,16 @@ tagged commit should be tested locally before it is uploaded::
pytest -n 8 .


In addition the following two tests should be run and manually inspected::
In addition the following test should be run and manually inspected::

python unit/memleak.py agg agg.pdf


In addition the following should be run and manually inspected, but
is currently broken::

python unit/memleak_hawaii3.py
pushd examples/tests/
python backend_driver.py
python backend_driver_sgskip.py
popd


Expand All @@ -45,7 +50,11 @@ In addition the following two tests should be run and manually inspected::
GitHub Stats
------------

We automatically extract GitHub issue, PRs, and authors from GitHub via the API::

We automatically extract GitHub issue, PRs, and authors from GitHub via the API.
copy the current :file:`github_stats.rst` to :file:`github_stats_X.Y.Z.rst`.

To re-generate the updated ::

python tools/github_stats.py --since-tag v2.2.0 --milestone=v3.0 --project 'matplotlib/matplotlib' --links > doc/users/github_stats.rst

Expand All @@ -65,6 +74,9 @@ Review and commit changes. Some issue/PR titles may not be valid rst (the most
Update and Validate the Docs
----------------------------

Merge the most recent 'doc' branch (``v3.0.2-doc``) into the branch you
are going to tag on and delete the doc branch on GitHub.

Before tagging, update the "what's new" and "API changes" listings.

for the "what's new"
Expand Down Expand Up @@ -96,6 +108,7 @@ need to create a python2 environment with ``requests==2.9.0`` and linkchecker ::
pip install linkchecker
pushd doc/build/html
linkchecker index.html --check-extern
popd

Address any issues which may arise. The internal links are checked on travis, this should only
flag failed external links.
Expand Down
13 changes: 13 additions & 0 deletions tools/github_stats.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,3 +227,16 @@ def report(issues, show_urls=False):
print()
print('Issues (%d):\n' % n_issues)
report(issues, show_urls)
print()
print()
print("""Previous GitHub Stats
---------------------


.. toctree::
:maxdepth: 1
:glob:

github_stats_*

""")