diff options
author | Ralf Gommers <ralf.gommers@gmail.com> | 2020-05-25 22:26:19 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-05-25 22:26:19 +0200 |
commit | ae7383b87f854026784eaf255de79da441c74dd6 (patch) | |
tree | e8db352b0a3a7052a34ded8b84ea4762f2d91163 | |
parent | 461780702559738b4b4f2dbd39fce54702832ccc (diff) | |
parent | 04992804220b61d5cc8a42718e2600b6d4f7d2da (diff) | |
download | numpydoc-ae7383b87f854026784eaf255de79da441c74dd6.tar.gz |
Merge pull request #264 from larsoner/doc
MAINT: Add release notes and bump version
-rw-r--r-- | doc/Makefile | 4 | ||||
-rw-r--r-- | doc/index.rst | 3 | ||||
-rw-r--r-- | doc/release_notes.rst | 73 | ||||
-rw-r--r-- | numpydoc/__init__.py | 2 |
4 files changed, 81 insertions, 1 deletions
diff --git a/doc/Makefile b/doc/Makefile index 0612444..fac7acf 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 a55ad45..05e01ea 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 0000000..25c6b63 --- /dev/null +++ b/doc/release_notes.rst @@ -0,0 +1,73 @@ +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 heading levels, adding TOC + +.. contents:: Page contents + :local: + :depth: 2 + +.. note:: + + For release notes (sparsely) kept prior to 1.0.0, look at the `releases page + on GitHub <https://github.com/numpy/numpydoc/releases>`__. + +1.0.0 +----- + +**Implemented enhancements:** + +- ENH: Add args and kwargs to example `#258 <https://github.com/numpy/numpydoc/pull/258>`__ (`larsoner <https://github.com/larsoner>`__) +- MAINT,STY: Upgrade to bionic, and change style similar to NumPy `#253 <https://github.com/numpy/numpydoc/pull/253>`__ (`mwtoews <https://github.com/mwtoews>`__) +- Delay import of Sphinx `#248 <https://github.com/numpy/numpydoc/pull/248>`__ (`cgohlke <https://github.com/cgohlke>`__) +- Adding –validate option \__main_\_ and run new validation `#240 <https://github.com/numpy/numpydoc/pull/240>`__ (`datapythonista <https://github.com/datapythonista>`__) +- Add docstring validation script (from pandas) `#238 <https://github.com/numpy/numpydoc/pull/238>`__ (`datapythonista <https://github.com/datapythonista>`__) +- ENH: Test full output and coverage `#230 <https://github.com/numpy/numpydoc/pull/230>`__ (`larsoner <https://github.com/larsoner>`__) +- DOC: Add description for blank lines after the docstring. `#229 <https://github.com/numpy/numpydoc/pull/229>`__ (`bingyao <https://github.com/bingyao>`__) + +Fixed bugs +~~~~~~~~~~ + +- References outside function `#214 <https://github.com/numpy/numpydoc/issues/214>`__ +- FIX: Get doc of actual class in test `#262 <https://github.com/numpy/numpydoc/pull/262>`__ (`larsoner <https://github.com/larsoner>`__) +- TST: Add inherited method `#260 <https://github.com/numpy/numpydoc/pull/260>`__ (`larsoner <https://github.com/larsoner>`__) +- Fixes references outside function (#214) `#259 <https://github.com/numpy/numpydoc/pull/259>`__ (`Hoxbro <https://github.com/Hoxbro>`__) +- Disable escaping “\*” on signature `#256 <https://github.com/numpy/numpydoc/pull/256>`__ (`tk0miya <https://github.com/tk0miya>`__) +- MAINT: clean-up unused objects `#254 <https://github.com/numpy/numpydoc/pull/254>`__ (`mwtoews <https://github.com/mwtoews>`__) +- STY: Reword first lines of example.py docstrings `#246 <https://github.com/numpy/numpydoc/pull/246>`__ (`justinludwig <https://github.com/justinludwig>`__) +- DOC: Fixed three formatting issues in docs `#245 <https://github.com/numpy/numpydoc/pull/245>`__ (`rossbar <https://github.com/rossbar>`__) +- STY Minor style improvements to doc/example.py to pass validation `#243 <https://github.com/numpy/numpydoc/pull/243>`__ (`rth <https://github.com/rth>`__) +- BUG: Allow no . at end if indented `#239 <https://github.com/numpy/numpydoc/pull/239>`__ (`larsoner <https://github.com/larsoner>`__) +- DOC: Update links and code checkers info in format.rst `#228 <https://github.com/numpy/numpydoc/pull/228>`__ (`bingyao <https://github.com/bingyao>`__) +- DOC: Update links and info in conf.py. `#227 <https://github.com/numpy/numpydoc/pull/227>`__ (`bingyao <https://github.com/bingyao>`__) +- BUG: Fix full rebuilds `#226 <https://github.com/numpy/numpydoc/pull/226>`__ (`larsoner <https://github.com/larsoner>`__) +- MAINT: doctest and pytest `#225 <https://github.com/numpy/numpydoc/pull/225>`__ (`larsoner <https://github.com/larsoner>`__) +- Py3fy some doctests. `#224 <https://github.com/numpy/numpydoc/pull/224>`__ (`anntzer <https://github.com/anntzer>`__) +- MAINT: fix trivial source comment typos `#222 <https://github.com/numpy/numpydoc/pull/222>`__ (`luzpaz <https://github.com/luzpaz>`__) +- Add missing headings to code examples `#252 <https://github.com/numpy/numpydoc/pull/252>`__ (`Cadair <https://github.com/Cadair>`__) + +Removed +~~~~~~~ + +- MNT Drop Python 2.7 and 3.4 support `#236 <https://github.com/numpy/numpydoc/pull/236>`__ (`rth <https://github.com/rth>`__) + +Closed issues +~~~~~~~~~~~~~ + +- Prefix added to reference keys in class docstrings `#263 <https://github.com/numpy/numpydoc/issues/263>`__ +- Test failure with python 3.9 `#261 <https://github.com/numpy/numpydoc/issues/261>`__ +- sphinx doc napoleon extension maintainer interest request `#251 <https://github.com/numpy/numpydoc/issues/251>`__ +- Missing reference to float_power function in the ufunc list `#250 <https://github.com/numpy/numpydoc/issues/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 8058bb5..e4038f0 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): |