summaryrefslogtreecommitdiff
path: root/tests/test_ext_autodoc_autoattribute.py
Commit message (Collapse)AuthorAgeFilesLines
* Document ``typing.NewType`` as a class (#10700)Adam Turner2023-01-021-30/+0
|
* Drop python 3.6 support (#10468)Takeshi KOMIYA2022-06-161-23/+10
|
* Remove redundant code for Python < 3.6Hugo van Kemenade2022-05-011-5/+0
|
* Merge branch '4.x'Takeshi KOMIYA2022-03-191-8/+3
|\
| * Remove copyright and licence fieldsAdam Turner2022-02-201-3/+0
| |
| * Conform to PEP 257 summary line conventionsAdam Turner2022-02-201-2/+4
| |
| * 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
| |
* | Merge branch '4.x'Takeshi KOMIYA2022-02-191-1/+1
|\ \ | |/
| * Close #10146: autodoc: autodoc_default_options does not support `no-value` ↵Takeshi KOMIYA2022-01-311-1/+1
| | | | | | | | option
* | autodoc: The default of autodoc_typehints_format becomes to 'smart'Takeshi KOMIYA2022-01-021-1/+1
|/ | | | | | | | The default value of autodoc_typehints_format configuration is changed to `'smart'`. It will suppress the leading module names of typehints (ex. `io.StringIO` -> `StringIO`). refs: #9075
* Merge pull request #10034 from tk0miya/10027_autodoc_typehints_format_for_basesTakeshi KOMIYA2022-01-021-1/+1
|\ | | | | Fix #10027: autodoc_typehints_format does not work with :show-inheritance:
| * Fix #10027: autodoc_typehints_format does not work with :show-inheritance:Takeshi KOMIYA2022-01-011-1/+1
| |
* | A happy new year!Takeshi KOMIYA2022-01-011-1/+1
|/
* Fix #9752: autodoc: Failed to detect type annotation for slots attributeTakeshi KOMIYA2021-10-231-0/+1
|
* Fix #9630: autodoc: Failed to build xrefs if primary_domain is not 'py'Takeshi KOMIYA2021-09-141-2/+2
| | | | | | | | Autodoc generates reST code that uses raw `:obj:` and `:class:` xrefs to refer the classes and types. But they're fragile because they assume the primary_domain=='py'. This adds `:py:` prefix to these xrefs to make them robust.
* Fix #9283: autodoc: failed to build doc for attribute not commentedTakeshi KOMIYA2021-05-301-0/+11
| | | | | | Autoattribute directive should check the existence of instance attribute that is defined inside __init__() but not having comments before accessing it.
* Fix #9110: autodoc: metadata of GenericAlias is not rendered as a reference ↵Takeshi KOMIYA2021-04-191-1/+1
| | | | | | | in py37+ GenericAliasMixin should use `restify()` to render the metadata of GenericAlias as py36 does.
* Merge branch '3.4.x' into 3.xTakeshi 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
* | Close #8022: autodoc: Allow to hide the value of the variables via metadataTakeshi KOMIYA2020-12-271-0/+26
|/ | | | | | autodata and autoattribute directives does not show right-hand value of the variable if its docstring contains ``:meta hide-value:`` in info-field-list.
* Fix #8534: autoattribute failed to document a commented attribute in alias classTakeshi KOMIYA2020-12-161-0/+28
| | | | | | | | So far, autoattribute uses "given class name" to fetch comments of uninitialized instance attributes. But pycode expects to use "real" class name on searching attribute comments. This adds UninitializedInstanceAttributeMixin to handle it simply.
* Fix #8503: autoattribute could not create document for a GenericAliasTakeshi KOMIYA2020-11-291-0/+26
|
* Fix #8480: autoattribute could not create document for __slots__ attributesTakeshi KOMIYA2020-11-231-0/+35
|
* Fix #8460: autodata directive does not display the detail of TypeVarsTakeshi KOMIYA2020-11-221-0/+15
| | | | | The details are only shown when automodule directive is used. This allows to document them via other auto* directives.
* Support NewType as a class attributeTakeshi KOMIYA2020-11-211-0/+15
|
* Make tests/ a Python packageFrançois Freitag2020-11-201-1/+2
| | | | Allows relative imports.
* Fix #8443: autoattribute does not support uninitialized ivarsTakeshi KOMIYA2020-11-201-0/+30
|
* autodoc: Fix :no-value: option for autoattribute does not workTakeshi KOMIYA2020-11-171-1/+0
|
* Rename :novalue: option to :no-value: optionTakeshi KOMIYA2020-11-151-0/+42
According to the existing options of autodoc directives, `:novalue:` option is now renamed to `:no-value:` option.