From 9370efecd3364f2b4ab7e9e8410d967e68724878 Mon Sep 17 00:00:00 2001 From: Eric Larson Date: Sat, 23 May 2020 20:01:54 -0400 Subject: [PATCH 1/3] MAINT: Add release notes and bump version --- doc/Makefile | 4 +++ doc/index.rst | 3 ++ doc/release_notes.rst | 70 +++++++++++++++++++++++++++++++++++++++++++ numpydoc/__init__.py | 2 +- 4 files changed, 78 insertions(+), 1 deletion(-) create mode 100644 doc/release_notes.rst diff --git a/doc/Makefile b/doc/Makefile index 0612444f..fac7acf8 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -45,6 +45,7 @@ help: @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " show to show the generated HTML" clean: -rm -rf $(BUILDDIR)/* @@ -182,3 +183,6 @@ pseudoxml: $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +show: + @python -c "import webbrowser; webbrowser.open_new_tab('file://$(PWD)/$(BUILDDIR)/html/index.html')" diff --git a/doc/index.rst b/doc/index.rst index a55ad457..05e01ea4 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -19,7 +19,10 @@ Documentation ============= .. toctree:: + :maxdepth: 2 + install + release_notes format example validation diff --git a/doc/release_notes.rst b/doc/release_notes.rst new file mode 100644 index 00000000..9d29e3ff --- /dev/null +++ b/doc/release_notes.rst @@ -0,0 +1,70 @@ +Release notes +============= + +.. roughly following https://sphinx-gallery.github.io/dev/maintainers.html, +.. 1.0.0 notes were generated by: +.. 1. tagging PRs as enhancement/bug/removed +.. 2. $ github_changelog_generator -u numpy -p numpydoc --since-tag=v0.9.2 +.. 3. $ pandoc CHANGELOG.md --wrap=none -o release_notes.rst +.. 4. adding a manual addition (CSS note), tweaking the heading levels, adding TOC + +.. contents:: Page contents + :local: + :depth: 2 + +.. note:: Release notes were not kept prior to version 1.0.0. + +1.0.0 +----- + +**Implemented enhancements:** + +- ENH: Add args and kwargs to example `#258 `__ (`larsoner `__) +- MAINT,STY: Upgrade to bionic, and change style similar to NumPy `#253 `__ (`mwtoews `__) +- Delay import of Sphinx `#248 `__ (`cgohlke `__) +- Adding –validate option \__main_\_ and run new validation `#240 `__ (`datapythonista `__) +- Add docstring validation script (from pandas) `#238 `__ (`datapythonista `__) +- ENH: Test full output and coverage `#230 `__ (`larsoner `__) +- DOC: Add description for blank lines after the docstring. `#229 `__ (`bingyao `__) + +Fixed bugs +~~~~~~~~~~ + +- References outside function `#214 `__ +- FIX: Get doc of actual class in test `#262 `__ (`larsoner `__) +- TST: Add inherited method `#260 `__ (`larsoner `__) +- Fixes references outside function (#214) `#259 `__ (`Hoxbro `__) +- Disable escaping “\*” on signature `#256 `__ (`tk0miya `__) +- MAINT: clean-up unused objects `#254 `__ (`mwtoews `__) +- STY: Reword first lines of example.py docstrings `#246 `__ (`justinludwig `__) +- DOC: Fixed three formatting issues in docs `#245 `__ (`rossbar `__) +- STY Minor style improvements to doc/example.py to pass validation `#243 `__ (`rth `__) +- BUG: Allow no . at end if indented `#239 `__ (`larsoner `__) +- DOC: Update links and code checkers info in format.rst `#228 `__ (`bingyao `__) +- DOC: Update links and info in conf.py. `#227 `__ (`bingyao `__) +- BUG: Fix full rebuilds `#226 `__ (`larsoner `__) +- MAINT: doctest and pytest `#225 `__ (`larsoner `__) +- Py3fy some doctests. `#224 `__ (`anntzer `__) +- MAINT: fix trivial source comment typos `#222 `__ (`luzpaz `__) +- Add missing headings to code examples `#252 `__ (`Cadair `__) + +Removed +~~~~~~~ + +- MNT Drop Python 2.7 and 3.4 support `#236 `__ (`rth `__) + +Closed issues +~~~~~~~~~~~~~ + +- Prefix added to reference keys in class docstrings `#263 `__ +- Test failure with python 3.9 `#261 `__ +- sphinx doc napoleon extension maintainer interest request `#251 `__ +- Missing reference to float_power function in the ufunc list `#250 `__ + +Additional notes +~~~~~~~~~~~~~~~~ + +- CSS styling changed from NumpyDoc < 0.8 and Sphinx < 2.0 to more properly make use of definition lists. This can cause issues with rendering that can be fixed via CSS, especially when using ``sphinx-rtd-theme``. For more information, see: + + - https://github.com/numpy/numpydoc/issues/215#issuecomment-568261611 + - https://github.com/readthedocs/sphinx_rtd_theme/pull/838 diff --git a/numpydoc/__init__.py b/numpydoc/__init__.py index 8058bb52..e4038f01 100644 --- a/numpydoc/__init__.py +++ b/numpydoc/__init__.py @@ -2,7 +2,7 @@ This package provides the numpydoc Sphinx extension for handling docstrings formatted according to the NumPy documentation format. """ -__version__ = '1.0.0.dev0' +__version__ = '1.0.0' def setup(app, *args, **kwargs): From c93886bb86524ac390a6a2289acb0cdb7b9bb375 Mon Sep 17 00:00:00 2001 From: Eric Larson Date: Sat, 23 May 2020 20:17:15 -0400 Subject: [PATCH 2/3] FIX: Notes --- doc/release_notes.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/release_notes.rst b/doc/release_notes.rst index 9d29e3ff..20aaff9a 100644 --- a/doc/release_notes.rst +++ b/doc/release_notes.rst @@ -12,7 +12,10 @@ Release notes :local: :depth: 2 -.. note:: Release notes were not kept prior to version 1.0.0. +.. note:: + + For notes (sparsely) kept prior to 1.0.0, look at the `releases page on + GitHub `__. 1.0.0 ----- From 04992804220b61d5cc8a42718e2600b6d4f7d2da Mon Sep 17 00:00:00 2001 From: Eric Larson Date: Sat, 23 May 2020 20:17:43 -0400 Subject: [PATCH 3/3] STY: Wording --- doc/release_notes.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/release_notes.rst b/doc/release_notes.rst index 20aaff9a..25c6b636 100644 --- a/doc/release_notes.rst +++ b/doc/release_notes.rst @@ -6,7 +6,7 @@ Release notes .. 1. tagging PRs as enhancement/bug/removed .. 2. $ github_changelog_generator -u numpy -p numpydoc --since-tag=v0.9.2 .. 3. $ pandoc CHANGELOG.md --wrap=none -o release_notes.rst -.. 4. adding a manual addition (CSS note), tweaking the heading levels, adding TOC +.. 4. adding a manual addition (CSS note), tweaking heading levels, adding TOC .. contents:: Page contents :local: @@ -14,8 +14,8 @@ Release notes .. note:: - For notes (sparsely) kept prior to 1.0.0, look at the `releases page on - GitHub `__. + For release notes (sparsely) kept prior to 1.0.0, look at the `releases page + on GitHub `__. 1.0.0 -----