Skip to content
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.

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

Pin sphinxcontrib-napoleon to latest version 0.7 #262

Closed
wants to merge 1 commit into from

Conversation

pyup-bot
Copy link
Contributor

@pyup-bot pyup-bot commented Feb 3, 2024

This PR pins sphinxcontrib-napoleon to the latest release 0.7.

Changelog

0.7

------------------------

* Drops support for Python 2.6 and 3.3 (may still work, but no longer tested)
* Adds support for Python 3.7
* Automatically adds 'sphinx.ext.autodoc' extension if needed
* Improved rendering of "Raises" section
* Improved type rendering for "Attributes" section
* Improved support for inline attribute docstrings
* Adds :ivar: type qualification
* Adds user defined custom sections
* Adds the following system defined sections:
 * Attention
 * Caution
 * Danger
 * Error
 * Hint
 * Important
 * Tip

0.6.1

--------------------------

* Excludes tests directory from package contents

0.6.0

--------------------------

* No longer prevents other 'autodoc-skip-member' handlers from running.
If Napoleon doesn't care if a member is skipped, then the decision is
deferred to autodoc and other extensions that handle 'autodoc-skip-member'.

0.5.4

--------------------------

* Improves param type parsing

0.5.3

--------------------------

* Fixes parsing of Google style parameter types that contain parenthesis

0.5.2

--------------------------

* Fixes issue in which monkey patching :keyword: support breaks with older
versions of Sphinx (at least sphinx<=1.2.3)

0.5.1

--------------------------

* Fixes bad formatting when a literal block is opened on the first line of a
parameter description
* Corrects minor formatting issue on example NumPy Attributes section
* Adds config option "napoleon_include_init_with_doc" to force inclusion
of standalone __init__ method in generated docs
* Adds config option "napoleon_use_keyword" to render keyword args with type
links

0.5.0

--------------------------

* Removes dependency on Sphinx, allows non-sphinx projects to use napoleon

0.4.4

--------------------------

* Fixes issue in which bulleted lists in parameter descriptions could cause
the sphinx builder to fail

0.4.3

--------------------------

* Backslash escape asterisks in *args and **kwargs for NumPy docstrings

0.4.2

--------------------------

* Fixes bad Python 3.2 syntax ('u' string literal)

0.4.1

--------------------------

* Sets napoleon_include_special_with_doc to False by default
* Removes upper bound on required Sphinx version (sphinx>=1.3 now allowed)

0.4

------------------------

* Adds support for Todo section header and Todo extension integration
* Changes __unicode__ to conditionally use "u" literal string for
Python 3.2 compatibility

0.3.11

---------------------------

* NumpyDoc section headers may be delimited by two or more underline characters
* Google style section headers must be followed by exactly one colon

0.3.10

---------------------------

* Undoes formatting changes in version 0.3.7
* Description ALWAYS starts on same line as type in output::

 attr (type): description

renders as::

 .. attribute:: attr

    *type* -- description

whereas::

 attr (type):
     description

ALSO renders as::

 .. attribute:: attr

    *type* -- description

0.3.9

--------------------------

* Formatting in Raises section updated to match Args, Returns, Yields, etc...
* If a newline is present immediately after the colon in Raises section, then
the output will also have a line break, with no m-dash separator

0.3.8

--------------------------

* Fixes formatting in Raises section when type contains cross references

0.3.7

--------------------------

* Adds explicit type parsing for inline attribute and property docs.
* Attribute types are no longer rendered on a separate line if the source
docstring did not use a newline after the type::

 attr (type): description

renders as::

 .. attribute:: attr

    *type* -- description

whereas::

 attr (type):
     description

renders as::

 .. attribute:: attr

    *type*

    description

0.3.6

--------------------------

* Removes docutils inline parser because it is incompatible with more recent
versions of docutils.

0.3.5

--------------------------

* Uses docutils to parse inline markup in params, attributes, return types...

0.3.4

--------------------------

* Correctly handles Return types containing colons in Google-style docstrings

0.3.3

--------------------------

* Adds support for "Usage" section

0.3.2

--------------------------

* Correctly handles Return types containing colons in NumPy-style docstrings

0.3.1

--------------------------

* Removes 2to3 from setup.py
* Enables bdist_wheel distributions

0.3

------------------------

* Adds six dependency
* Adds pockets dependency
* Removes iterators module (now found in pockets package)
* Removes pavertasks module, deemed redundant as it simply called sphinx-apidoc

0.2.11

---------------------------

* Fix Google Docstring argument regex. Argument types now more permissive,
allowing spaces and other special characters.

0.2.10

---------------------------

* Adds "Yield" alias for "Yields" section

0.2.9

--------------------------

* Fixes bug which silently omitted *args and **kwargs parameters
* Fixes bug where ignored parameter if description is empty

0.2.8

--------------------------

* Fixes bug which failed to render links in attribute types

0.2.7

--------------------------

* Fixes import error when processing namedtuples
* Adds Python 3.4 as a tox environment

0.2.6

--------------------------

* Fixes "Args:" type parsing bug in Google style docs

0.2.5

--------------------------

* Fixes Python 3.3 bug which included private and special members in the docs
* Fixes bug which failed to render links in function parameter types
* Adds support for See Also refs written using the NumpyDoc style
* Uses unittest.mock for Python >= 3.3

0.2.4

--------------------------

* Drops official support for 3.1
* Brings code into parity with Sphinx 1.3 "sphinx.ext.napoleon"
* Restricts allowable Sphinx version to < 1.3

0.2.3

--------------------------

* Adds python 3.1 support
* Fixes tests for python 3.*
* Adds tox environments: py26,py27,py31,py32,py33,pypy

0.2.2

--------------------------

* Adds python 3 support

0.2.1

--------------------------

* Corrects package url in setup.py

0.2

------------------------

* Adds special handling for ``Keyword Arguments``
* Adds aliases for common section headers:

 * ``Args`` *(alias of Parameters)*
 * ``Arguments`` *(alias of Parameters)*
 * ``Keyword Args`` *(alias of Keyword Arguments)*
 * ``Return`` *(alias of Returns)*
 * ``Warnings`` *(alias of Warning)*

0.1.1

--------------------------

* Adds documentation.
* Fixes API docs for pavertasks.

0.1

------------------------

* Initial version.
Links

Verified

This commit was signed with the committer’s verified signature.
SWvheerden SW van Heerden
@stringertheory stringertheory deleted the pyup-pin-sphinxcontrib-napoleon-0.7 branch February 3, 2024 07:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants