From c242800b2458dec5e27c52f444e84c1a988ec354 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Fri, 22 Feb 2019 22:16:59 -0500 Subject: [PATCH 1/4] DOC: fix memleak test execution + note backend_driver is broken --- doc/devel/release_guide.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst index bf4b58d123f4..dc856e0a4201 100644 --- a/doc/devel/release_guide.rst +++ b/doc/devel/release_guide.rst @@ -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 From fa16e96c27034561e731da5015ce8c61703c5405 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Fri, 22 Feb 2019 22:17:23 -0500 Subject: [PATCH 2/4] DOC: add missing popd --- doc/devel/release_guide.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst index dc856e0a4201..dfb2ab8d8ecd 100644 --- a/doc/devel/release_guide.rst +++ b/doc/devel/release_guide.rst @@ -101,6 +101,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. From 3add36633b1a4b971e1e66dcb3698bc36f9d453a Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Fri, 22 Feb 2019 22:17:35 -0500 Subject: [PATCH 3/4] DOC: change not to backup github stats + add glob toc --- doc/devel/release_guide.rst | 6 +++++- tools/github_stats.py | 13 +++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst index dfb2ab8d8ecd..d77854058a0a 100644 --- a/doc/devel/release_guide.rst +++ b/doc/devel/release_guide.rst @@ -50,7 +50,11 @@ is currently broken:: 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 diff --git a/tools/github_stats.py b/tools/github_stats.py index 56debbc34e8e..04d5ffb8646f 100755 --- a/tools/github_stats.py +++ b/tools/github_stats.py @@ -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_* + +""") From 758b07143648530c17364a3c026de410236fb86e Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Fri, 22 Feb 2019 22:33:46 -0500 Subject: [PATCH 4/4] DOC: add note about merging up the docs branch. --- doc/devel/release_guide.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst index d77854058a0a..e47bea19c9f7 100644 --- a/doc/devel/release_guide.rst +++ b/doc/devel/release_guide.rst @@ -74,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"