summaryrefslogtreecommitdiff
path: root/sphinx/ext/napoleon/docstring.py
Commit message (Collapse)AuthorAgeFilesLines
* Resolve ``flake8-return`` errorsAdam Turner2023-02-181-1/+1
|
* Fix COM812Adam Turner2023-02-181-13/+13
|
* Resolve Ruff SIM114 violationsAdam Turner2023-02-151-3/+1
|
* Collapse ``.startswith`` and ``.endswith`` testsAdam Turner2023-02-091-2/+2
|
* Use PEP 604 display for ``typing.Optional`` and ``typing.Union`` (#11072)Adam Turner2023-01-021-3/+3
|
* Use ``any`` to find elements in iterable (#11053)danieleades2023-01-021-1/+1
|
* Run pyupgrade (#11070)Adam Turner2023-01-021-12/+12
|
* Use PEP 604 typesAdam Turner2023-01-011-12/+12
|
* Use PEP 595 typesAdam Turner2023-01-011-70/+70
|
* Insert ``from __future__ import annotations``Adam Turner2023-01-011-0/+2
|
* Tighten mypy 'strict optional' whitelist (#11038)danieleades2022-12-291-13/+31
| | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* Clean up after dropping Python 3.6Adam Turner2022-09-271-2/+0
|
* Merge branch '5.x'Jean-François B2022-08-061-2/+4
|\
| * Fix flake8 5.0.0 reported formatting errorsdaniel.eades2022-08-011-2/+4
| |
| * Fix ValueError popping out in `sphinx.ext.napoleon` (#10709)Antony Lee2022-07-251-12/+22
| | | | | | There's some parts of the code still expecting a StopIteration instead.
* | Merge branch '5.x'Adam Turner2022-07-261-12/+22
|\ \
| * | Fix ValueError popping out in `sphinx.ext.napoleon` (#10709)Antony Lee2022-07-251-12/+22
| |/ | | | | There's some parts of the code still expecting a StopIteration instead.
* | Merge branch '5.x' into masterJean-François B2022-06-301-31/+43
|\ \ | |/ | | | | | | | | | | | | Resolved merge conflicts: sphinx/ext/extlinks.py sphinx/ext/napoleon/docstring.py (and removed from the latter a now unused import for flake8 F401 compliance)
| * Replace `napoleon.iterators` by simpler stack implementation (#9856)Antony Lee2022-06-261-31/+43
| |
* | Remove deprecated items for Sphinx 6.0 (#10471)Adam Turner2022-06-161-16/+1
|/
* remove unnecessary generators (C400, C401)Daniel Eades2022-06-031-2/+2
|
* Fix whitespaceAdam Turner2022-03-071-5/+1
|
* Remove copyright and licence fieldsAdam Turner2022-02-201-3/+0
|
* Fix module docstring indentationAdam Turner2022-02-201-3/+3
|
* Remove module titles in docstringsAdam Turner2022-02-191-3/+0
|
* Fix #10181: napoleon_use_ivar adds unexpected prefix to varsTakeshi KOMIYA2022-02-121-1/+4
| | | | | | | | Since 4.0, :ivar: items has not been rendered as hyperlinks. So any modules, classes and tilda are now harmful. This removes the prefixing filter for napoleon_use_ivar option. refs: #5129 and #5977
* Merge pull request #10101 from Gobot1234/4.xTakeshi KOMIYA2022-01-161-6/+4
|\ | | | | Fix empty returns section
| * Only add returns section if there is somethingJames Hilton-Balfe2022-01-151-6/+4
| |
* | A happy new year!Takeshi KOMIYA2022-01-011-1/+1
|/
* refactor: use raw Type for type annotationsTakeshi KOMIYA2021-04-041-1/+1
|
* refactor: Use PEP-526 based variable annotation (sphinx.ext)Takeshi KOMIYA2021-03-151-11/+11
|
* Merge branch '3.x'Takeshi KOMIYA2021-01-241-4/+27
|\
| * Fix #8004: napoleon_preprocess_types for Google style docstringsTakeshi KOMIYA2021-01-231-4/+27
| | | | | | | | | | Type definitions in Google style docstrings are rendered as references when :confval:`napoleon_preprocess_types` enabled.
* | Merge branch '3.x'Takeshi KOMIYA2021-01-221-5/+19
|\ \ | |/
| * Close #8573: napoleon: Add more custom section stylesSolidifiedRay2021-01-181-5/+19
| |
* | Close #5560: napoleon_use_param also affect "other parameters" sectionTakeshi KOMIYA2021-01-201-1/+7
| |
* | Merge branch '3.x'Takeshi KOMIYA2021-01-011-1/+1
|\ \ | |/
| * A happy new year!Takeshi KOMIYA2021-01-011-1/+1
| | | | | | | | | | | | | | .. note:: $ find sphinx tests LICENSE doc/conf.py -type f -exec sed -i '' -e 's/2007\-20../2007-2021/' {} \; $ git co sphinx/locale/**/*.js sphinx/templates/epub3/mimetype
* | Merge branch '3.x'Takeshi KOMIYA2020-12-201-0/+11
|\ \ | |/
| * Close #8236: napoleon: Support numpydoc's "Receives" sectionTakeshi KOMIYA2020-12-191-0/+11
| |
* | Merge branch '3.x'Takeshi KOMIYA2020-12-141-0/+22
|\ \ | |/
| * removed unnecessary 'or {}'Quentin Soubeyran2020-11-251-1/+1
| |
| * enabled feature for module docstringQuentin Soubeyran2020-11-251-1/+1
| |
| * implemented feature in numpy style, factored common codeQuentin Soubeyran2020-11-251-11/+20
| |
| * refactored code and tests, prepared for numpy featureQuentin Soubeyran2020-11-251-18/+9
| |
| * added behavior for exceptionsQuentin Soubeyran2020-11-251-1/+1
| |
| * corrected too long line for flake8Quentin Soubeyran2020-11-251-1/+2
| |
| * added napoleon_google_attr_annotations option to use PEP 526 on google styleQuentin Soubeyran2020-11-251-1/+22
| |
* | Do isortTakeshi KOMIYA2020-11-121-1/+0
| |
* | Merge branch '3.x'Takeshi KOMIYA2020-11-021-29/+32
|\ \ | |/