summaryrefslogtreecommitdiff
path: root/sphinx/util/docfields.py
Commit message (Collapse)AuthorAgeFilesLines
* Fix COM812Adam Turner2023-02-181-1/+1
|
* Run pyupgrade (#11070)Adam Turner2023-01-021-1/+1
|
* Use PEP 604 typesAdam Turner2023-01-011-2/+2
|
* Use PEP 595 typesAdam Turner2023-01-011-18/+18
|
* Insert ``from __future__ import annotations``Adam Turner2023-01-011-0/+2
|
* Remove copyright and licence fieldsAdam Turner2022-02-201-3/+0
|
* Conform to PEP 257 summary line conventionsAdam Turner2022-02-201-1/+3
|
* Fix module docstring indentationAdam Turner2022-02-201-3/+3
|
* Fix module docstring first lineAdam Turner2022-02-201-2/+1
|
* Remove module titles in docstringsAdam Turner2022-02-191-3/+0
|
* Fix typing in docfields.pyPhilipp A2022-01-111-1/+1
|
* merge 'isinstance' calls (SIM101)Daniel Eades2022-01-101-2/+1
|
* Merge branch '4.3.x' into 4.xTakeshi KOMIYA2022-01-011-1/+1
|\
| * A happy new year!Takeshi KOMIYA2022-01-011-1/+1
| |
* | Fix some messages are still not translatedTakeshi KOMIYA2021-12-271-2/+2
|/
* DocFields, small fixesJakob Lykke Andersen2021-06-031-8/+5
|
* fields, call roles instead of making a pending_xrefJakob Lykke Andersen2021-06-031-24/+55
| | | | Except for py which has mixins that assumes a single pending_xref
* Fix #9224: info-field-list does not support a type containing spaceTakeshi KOMIYA2021-05-151-1/+1
| | | | | | | | | So far, DocFieldTransformer has split the field name for `:type:` and `:param:` at the first whitespace. Therefore, it does not allow to use a type containing whitespace (ex. `Dict[str, str]`). This changes the splitting logic to divide the field name at the last whitespace (a.k.a `rstrip()`). It allows to use whitespaces on types.
* refactor: Add Optional to type annotationsTakeshi KOMIYA2021-05-031-1/+1
|
* Merge branch 'master' into refactor_type_annotation2Takeshi KOMIYA2021-04-081-6/+6
|\
| * refactor: Lazy loading is not needed for type annotationsTakeshi KOMIYA2021-04-041-6/+6
| |
* | refactor: use raw Type for type annotationsTakeshi KOMIYA2021-04-041-2/+2
|/
* refactor: Use PEP-526 based variable annotation (sphinx.util)Takeshi KOMIYA2021-03-101-6/+6
|
* 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/+1
|\ \ | |/
| * Fix #8365: py domain: :type: and :rtype: gives false ambiguous warningsTakeshi KOMIYA2020-12-191-0/+1
| | | | | | | | | | | | The searching context like py:module and py:class are missing in the pending_xref nodes generated from info-field-lists. This sets these searching context info to them.
* | Merge branch '3.x'Takeshi KOMIYA2020-11-121-3/+2
|\ \ | |/
| * Sort imports with isortFrançois Freitag2020-11-111-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | Keep imports alphabetically sorted and their order homogeneous across Python source files. The isort project has more feature and is more active than the flake8-import-order plugin. Most issues caught were simply import ordering from the same module. Where imports were purposefully placed out of order, tag with isort:skip.
| * Add stacklevel parameter to warnings.warn() callTakeshi KOMIYA2020-05-031-2/+2
| |
* | Remove deprecated features marked as RemovedInSphinx40WarningTakeshi KOMIYA2020-04-291-22/+1
| |
* | Hello TYPE_CHECKING!Takeshi KOMIYA2020-03-071-3/+2
| |
* | Deprecate codes for python 3.5Takeshi KOMIYA2020-03-071-2/+1
|/
* A happy new year!Takeshi KOMIYA2020-01-011-1/+1
|
* Fix #6474: ``DocFieldTransformer`` raises AttributeErrorTakeshi KOMIYA2019-08-021-1/+8
|
* Fix type annotation for python 3.5.1Takeshi KOMIYA2019-07-131-3/+4
|
* Migrate to py3 style type annotation: sphinx.util.docfieldsTakeshi KOMIYA2019-06-031-67/+32
|
* Add ObjectDescription.get_field_type_map()Takeshi KOMIYA2019-03-231-5/+7
| | | | | Conceal caching mechanism of Field classes to ObjectDescription class. This deprecates DocFieldTransformer.preprocess_field_types().
* Clean up import for annotationsTakeshi KOMIYA2019-03-061-1/+0
|
* Merge branch '1.8'Takeshi KOMIYA2019-01-021-1/+1
|\
| * A happy new year!Takeshi KOMIYA2019-01-021-1/+1
| |
* | Merge pull request #5509 from stephenfin/remove-future-importsTakeshi KOMIYA2018-12-171-1/+0
|\ \ | | | | | | Remove future imports
| * | py3: Remove (most) __future__ importsStephen Finucane2018-12-171-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There were two used: - print_function - absolute_import Both of these are mandatory in Python 3.0 onwards [1] and can therefore be removed...mostly. Unfortunately, mypy is still running in Python 2.7 mode, meaning we need the 'print_function' future wherever we're calling 'print' with the 'file' argument. There's also a single 'absolute_import' future that must be retained as its removal breaks a test for as-yet unknown reasons. TODOs are added to resolve both issues in the future. [1] https://docs.python.org/3/library/__future__.html Signed-off-by: Stephen Finucane <stephen@that.guru>
* | | Remove unnecessary encoding cookie from Python source filesJon Dufresne2018-12-161-1/+0
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | In Python 3, the default encoding of source files is utf-8. The encoding cookie is now unnecessary and redundant so remove it. For more details, see the docs: https://docs.python.org/3/howto/unicode.html#the-string-type > The default encoding for Python source code is UTF-8, so you can > simply include a Unicode character in a string literal ... Includes a fix for the flake8 header checks to stop expecting an encoding cookie.
* | Use Python 3 super() argument-less syntaxJon Dufresne2018-12-151-2/+2
| | | | | | | | | | | | The form is less verbose and more idiomatic for Python 3 only code. https://docs.python.org/3/library/functions.html#super
* | Replace all "unicode" type by "str"Takeshi KOMIYA2018-12-151-22/+22
| |
* | Fix annotaions for docfieldsTakeshi KOMIYA2018-12-121-15/+15
| |
* | Merge pull request #5740 from tk0miya/fix_typehints_for_TextlikeNodeTakeshi KOMIYA2018-12-101-3/+3
|\ \ | | | | | | Add TextlikeNode type for docfields
| * | Add TextlikeNode type for docfieldsTakeshi KOMIYA2018-12-101-3/+3
| | |
* | | Fix annotationsTakeshi KOMIYA2018-12-101-1/+1
|/ /