Takeshi KOMIYA
9a9433e403
Fix #9283 : autodoc: failed to build doc for attribute not commented
...
Autoattribute directive should check the existence of instance attribute
that is defined inside __init__() but not having comments before
accessing it.
2021-05-30 19:48:11 +09:00
Takeshi KOMIYA
58ec5c4089
Fix #9110 : autodoc: metadata of GenericAlias is not rendered as a reference in py37+
...
GenericAliasMixin should use `restify()` to render the metadata of
GenericAlias as py36 does.
2021-04-19 01:11:08 +09:00
Takeshi KOMIYA
7ecf6b88aa
Merge branch '3.4.x' into 3.x
2021-01-01 13:56:19 +09:00
Takeshi KOMIYA
f996859420
A happy new year!
...
.. 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
2021-01-01 13:40:48 +09:00
Takeshi KOMIYA
9e9e486e65
Close #8022 : autodoc: Allow to hide the value of the variables via metadata
...
autodata and autoattribute directives does not show right-hand value of
the variable if its docstring contains ``:meta hide-value:`` in
info-field-list.
2020-12-27 12:46:03 +09:00
Takeshi KOMIYA
caa1d1f3c2
Fix #8534 : autoattribute failed to document a commented attribute in alias class
...
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.
2020-12-16 02:43:31 +09:00
Takeshi KOMIYA
bb63f03034
Fix #8503 : autoattribute could not create document for a GenericAlias
2020-11-29 12:24:10 +09:00
Takeshi KOMIYA
50dad211ed
Fix #8480 : autoattribute could not create document for __slots__ attributes
2020-11-23 15:28:53 +09:00
Takeshi KOMIYA
9eb96d5c79
Fix #8460 : autodata directive does not display the detail of TypeVars
...
The details are only shown when automodule directive is used. This
allows to document them via other auto* directives.
2020-11-22 13:57:48 +09:00
Takeshi KOMIYA
6973888294
Support NewType as a class attribute
2020-11-21 23:56:16 +09:00
François Freitag
419e145e36
Make tests/ a Python package
...
Allows relative imports.
2020-11-20 19:43:02 +01:00
Takeshi KOMIYA
dcd8ff544a
Fix #8443 : autoattribute does not support uninitialized ivars
2020-11-20 22:39:21 +09:00
Takeshi KOMIYA
f203a15141
autodoc: Fix :no-value: option for autoattribute does not work
2020-11-17 22:40:40 +09:00
Takeshi KOMIYA
5676fdeb4e
Rename :novalue: option to :no-value: option
...
According to the existing options of autodoc directives, `:novalue:`
option is now renamed to `:no-value:` option.
2020-11-15 14:20:30 +09:00
