Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 80a5e99

Browse files
choldgrafcholdgraf
authored
Merge pull request #8955 from QuLogic/doc-updates
Various documentation updates
2 parents 189cb98 + 0c44435 commit 80a5e99

34 files changed

Lines changed: 32 additions & 13 deletions

‎.circleci/config.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,9 @@ jobs:
108108
name: "Built documentation is available at:"
109109
command: echo "${CIRCLE_BUILD_URL}/artifacts/${CIRCLE_NODE_INDEX}/${CIRCLE_WORKING_DIRECTORY/#\~/$HOME}/doc/build/html/index.html"
110110

111+
- add_ssh_keys:
112+
fingerprints:
113+
- "78:13:59:08:61:a9:e5:09:af:df:3a:d8:89:c2:84:c0"
111114
- deploy:
112115
name: "Deploy new docs"
113116
command: ./.circleci/deploy-docs.sh

‎.circleci/deploy-docs.sh‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
set -e
44

5-
if [ "$CIRCLE_BRANCH" != "master" -o "$CIRCLE_PULL_REQUEST" != "" ]; then
6-
echo "Not uploading docs from non-master branch."
5+
if [ "$CIRCLE_PROJECT_USERNAME" != "matplotlib" -o "$CIRCLE_BRANCH" != "master" -o "$CIRCLE_PULL_REQUEST" != "" ]; then
6+
echo "Not uploading docs from non-master branch or non-Matplotlib org."
77
exit
88
fi
99

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ detail. Why is this change required? What problem does it solve?-->
2424
- [ ] Code is PEP 8 compliant
2525
- [ ] New features are documented, with examples if plot related
2626
- [ ] Documentation is sphinx and numpydoc compliant
27-
- [ ] Added an entry to doc/users/whats_new.rst if major new feature
27+
- [ ] Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
2828
- [ ] Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way
2929

3030
<!--We understand that PRs can sometimes be overwhelming, especially as the

‎doc/conf.py‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,11 @@ def _check_deps():
102102
'filename_pattern': '^((?!sgskip).)*$',
103103
'gallery_dirs': ['gallery', 'tutorials'],
104104
'doc_module': ('matplotlib', 'mpl_toolkits'),
105-
'reference_url': {'matplotlib': None,
106-
'numpy': 'http://docs.scipy.org/doc/numpy/reference',
107-
'scipy': 'http://docs.scipy.org/doc/scipy/reference'},
105+
'reference_url': {
106+
'matplotlib': None,
107+
'numpy': 'https://docs.scipy.org/doc/numpy',
108+
'scipy': 'https://docs.scipy.org/doc/scipy/reference',
109+
},
108110
'backreferences_dir': 'api/_as_gen'
109111
}
110112

‎doc/devel/release_guide.rst‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,10 @@ Review and commit changes. Some issue/PR titles may not be valid rst (the most
4848
Check Docs
4949
----------
5050

51-
Before tagging, make sure that the docs build cleanly ::
51+
Before tagging, update the what's new listing in :file:`doc/users/whats_new.rst`
52+
by merging all files in :file:`doc/users/next_whats_new/` coherently. Also,
53+
temporarily comment out the include and toctree glob; re-instate these after a
54+
release. Finally, make sure that the docs build cleanly ::
5255

5356
pushd doc
5457
python make.py html latex -n 16

doc/users/whats_new/2015-10-31_TransformedPatchPath.rst renamed to doc/users/next_whats_new/2015-10-31_TransformedPatchPath.rst

File renamed without changes.

doc/users/whats_new/CheckButtons_widget_get_status.rst renamed to doc/users/next_whats_new/CheckButtons_widget_get_status.rst

File renamed without changes.

doc/users/whats_new/README.rst renamed to doc/users/next_whats_new/README.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
This folder is for placing new portions of `whats_new.rst`.
1+
What's new in unreleased Matplotlib?
2+
====================================
3+
4+
Please place new portions of `whats_new.rst` in the `next_whats_new` directory.
25

36
When adding an entry please look at the currently existing files to
47
see if you can extend any of them. If you create a file, name it

doc/users/whats_new/abstract_movie_writer.rst renamed to doc/users/next_whats_new/abstract_movie_writer.rst

File renamed without changes.

doc/users/whats_new/anchoredsizebar_fill_bar_argument.rst renamed to doc/users/next_whats_new/anchoredsizebar_fill_bar_argument.rst

File renamed without changes.

0 commit comments

Comments
 (0)