summaryrefslogtreecommitdiff
path: root/tests/test_domain_py.py
Commit message (Collapse)AuthorAgeFilesLines
* Test for issue #10456: removing meta-fieldsAnselm Kruis2022-05-161-0/+2
| | | | | | Add two meta-fields to an appropriate test case. Currently the test fails, because of bug #10456. The next commit fixes the issue.
* `.read_text()` -> `.read_text(encoding='utf8')`Adam Turner2022-04-271-5/+5
|
* Collapse single line docstringsAdam Turner2022-02-201-2/+1
|
* Remove copyright and licence fieldsAdam Turner2022-02-201-3/+0
|
* Fix module docstring indentationAdam Turner2022-02-201-2/+2
|
* Fix module docstring first lineAdam Turner2022-02-201-2/+1
|
* Remove module titles in docstringsAdam Turner2022-02-191-3/+0
|
* test: Migrate to Node.findall() from Node.traverse()Takeshi KOMIYA2022-01-031-3/+3
|
* Merge branch '4.3.x' into 4.xTakeshi KOMIYA2022-01-011-1/+1
|\
| * A happy new year!Takeshi KOMIYA2022-01-011-1/+1
| |
* | Fix py domain: "typing" types are not hyperlinked in info-field-listTakeshi KOMIYA2021-12-271-1/+22
| |
* | py domain: Suppress the leading "typing." module from typehintsTakeshi KOMIYA2021-12-251-2/+2
| | | | | | | | | | | | | | To support creating hyperlinks to container types naturally, py domain should take fully-qualified typehints for them. But nobody wants to show "typing." module name on the signature. So this suppresses them automatically.
* | Fix #9194: autodoc: types in typing module are not hyperlinkedTakeshi KOMIYA2021-12-251-1/+3
| | | | | | | | | | This converts types in typing module to valid references when `autodoc_unqualified_typehints` option enabled.
* | Fix autodoc: Failed to parse Literal type in py36 and py37Takeshi KOMIYA2021-12-251-0/+9
|/
* test: Remove debug printTakeshi KOMIYA2021-12-191-1/+0
|
* py domain: Allow "~" prefix as a prefix of typehints in signatureTakeshi KOMIYA2021-11-301-0/+12
| | | | | | | | | | Now python domain supports the "~" prefix at the beginning of the typehints of the function signatures: .. py:function:: func(x: ~typing.Dict) It's rescognized as the same as python reference roles do (ex. :py:class:`~typing.Dict`).
* Fix #9899: py domain: Allows cross-reference specifier to :type: optionTakeshi KOMIYA2021-11-291-0/+22
|
* Fix #9775: py domain: Literal typehint was converted to a cross referenceTakeshi KOMIYA2021-10-301-0/+36
|
* Merge branch '4.x' into 9697_property_with_parensTakeshi KOMIYA2021-10-091-68/+101
|\
| * js/py nodes, update arglist renderingJakob Lykke Andersen2021-10-031-3/+3
| |
| * py nodes, isort fixJakob Lykke Andersen2021-10-021-3/+4
| |
| * py nodes, PyObject annoJakob Lykke Andersen2021-10-021-7/+8
| |
| * py nodes, PyProperty get_signature_prefixJakob Lykke Andersen2021-10-021-2/+4
| |
| * py nodes, PyMethod get_signature_prefixJakob Lykke Andersen2021-10-021-8/+8
| |
| * py nodes, PyClassLike, get_signature_prefixJakob Lykke Andersen2021-10-021-12/+15
| |
| * py nodes, PyFunction get_signature_prefixJakob Lykke Andersen2021-10-021-1/+3
| |
| * py nodes, PyPropertyJakob Lykke Andersen2021-10-021-2/+4
| |
| * py nodes, PyAttribute valueJakob Lykke Andersen2021-10-021-1/+5
| |
| * py nodes, PyAttribute typeJakob Lykke Andersen2021-10-021-3/+4
| |
| * py nodes, PyVariable valueJakob Lykke Andersen2021-10-021-1/+6
| |
| * py nodes, PyVariable typeJakob Lykke Andersen2021-10-021-4/+7
| |
| * py nodes, arglistJakob Lykke Andersen2021-10-021-13/+13
| |
| * py nodes, TupleJakob Lykke Andersen2021-10-021-7/+14
| |
| * py nodes, ListJakob Lykke Andersen2021-10-021-1/+3
| |
| * py nodes, BitOrJakob Lykke Andersen2021-10-021-5/+5
| |
* | Fix #9697: An index entry with parens was registered for py:methodTakeshi KOMIYA2021-10-031-1/+1
|/
* Fix #9576: py domain: Literal typehint was converted to a cross referenceTakeshi KOMIYA2021-09-031-0/+21
| | | | | The content of Literal typehint should not be converted to cross references.
* Fix #9585: py:property directive does not create a hyperlink for typesTakeshi KOMIYA2021-08-311-2/+4
|
* Cloase #9445: :py:property: directive now supports :classmethod: optionTakeshi KOMIYA2021-07-171-5/+19
| | | | | Since python 3.9, `classmethod` starts to support creating a "class property". This allows to describe it.
* Merge branch '4.x' into 9427Takeshi KOMIYA2021-07-111-15/+68
|\
| * Close #9268: python_use_unqualified_type_names supports type fieldTakeshi KOMIYA2021-06-031-0/+6
| |
| * Fix #9280: py domain: "exceptions" module is not displayedTakeshi KOMIYA2021-05-301-14/+2
| | | | | | | | | | | | | | | | | | | | Since v0.2, python domain gives a special treatment for the exceptions module to suppress its name on documenting exception classes. It had been worthy on python2 era. But the module has been removed since python3. Therefore, the special treatment becomes harmful for user libraries. This removes it to render module names correctly. Note: Now we've only supported python3. So this is not incompatible.
| * Close #1874: py domain: Support union types using `|` in info-field-listTakeshi KOMIYA2021-05-221-0/+34
| |
| * Fix #9224: info-field-list does not support a type containing spaceTakeshi KOMIYA2021-05-151-1/+26
| | | | | | | | | | | | | | | | | | 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.
* | py domain: Add testcase for empty callable (refs: #9427)Takeshi KOMIYA2021-07-111-0/+9
|/
* Fix #9205: py domain: canonical option causes xref resolution errorTakeshi KOMIYA2021-05-111-0/+11
| | | | | | The :canonical: option causes "more than one target for cross-reference" warning because the class having the same name is registered.
* Fix #9121: py domain: duplicated warning for canonical and aliasTakeshi KOMIYA2021-04-231-0/+33
| | | | | | A duplicated warning is emitted when both canonical and its alias objects are defined on the same document. But it should not be emitted because they're the same object, not conflicted.
* Fix #8127: py domain: Ellipsis in info-field-list causes nit-picky warningTakeshi KOMIYA2021-04-171-1/+24
| | | | | | | | | | On parsing the types, the leading dot of the ellipsis (...) is considered as a reference name. And its first dot is considered as a notation for relative type reference (ex. ".ClassName"). As a result, it was converted double dots unexpectedly. This changes the parsing rule to treat the ellipsis as a symbol, not a name.
* py domain: Add py:property directive to describe a property (refs: #7068)Takeshi KOMIYA2021-03-111-0/+27
|
* Fix #7199: py domain: Add a new confval: python_use_unqualified_type_namesTakeshi KOMIYA2021-03-061-0/+19
| | | | | | Add a new config variable: python_use_unqualified_type_names. If enabled, it goes to suppress the module name of the python reference if it can be resolved.