Commit message (Collapse) | Author | Age | Files | Lines | |
---|---|---|---|---|---|
* | Document ``typing.NewType`` as a class (#10700) | Adam Turner | 2023-01-02 | 1 | -30/+0 |
| | |||||
* | Drop python 3.6 support (#10468) | Takeshi KOMIYA | 2022-06-16 | 1 | -23/+10 |
| | |||||
* | Remove redundant code for Python < 3.6 | Hugo van Kemenade | 2022-05-01 | 1 | -5/+0 |
| | |||||
* | Merge branch '4.x' | Takeshi KOMIYA | 2022-03-19 | 1 | -8/+3 |
|\ | |||||
| * | Remove copyright and licence fields | Adam Turner | 2022-02-20 | 1 | -3/+0 |
| | | |||||
| * | Conform to PEP 257 summary line conventions | Adam Turner | 2022-02-20 | 1 | -2/+4 |
| | | |||||
| * | Fix module docstring indentation | Adam Turner | 2022-02-20 | 1 | -3/+3 |
| | | |||||
| * | Fix module docstring first line | Adam Turner | 2022-02-20 | 1 | -2/+1 |
| | | |||||
| * | Remove module titles in docstrings | Adam Turner | 2022-02-19 | 1 | -3/+0 |
| | | |||||
* | | Merge branch '4.x' | Takeshi KOMIYA | 2022-02-19 | 1 | -1/+1 |
|\ \ | |/ | |||||
| * | Close #10146: autodoc: autodoc_default_options does not support `no-value` ↵ | Takeshi KOMIYA | 2022-01-31 | 1 | -1/+1 |
| | | | | | | | | option | ||||
* | | autodoc: The default of autodoc_typehints_format becomes to 'smart' | Takeshi KOMIYA | 2022-01-02 | 1 | -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_bases | Takeshi KOMIYA | 2022-01-02 | 1 | -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 KOMIYA | 2022-01-01 | 1 | -1/+1 |
| | | |||||
* | | A happy new year! | Takeshi KOMIYA | 2022-01-01 | 1 | -1/+1 |
|/ | |||||
* | Fix #9752: autodoc: Failed to detect type annotation for slots attribute | Takeshi KOMIYA | 2021-10-23 | 1 | -0/+1 |
| | |||||
* | Fix #9630: autodoc: Failed to build xrefs if primary_domain is not 'py' | Takeshi KOMIYA | 2021-09-14 | 1 | -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 commented | Takeshi KOMIYA | 2021-05-30 | 1 | -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 KOMIYA | 2021-04-19 | 1 | -1/+1 |
| | | | | | | | in py37+ GenericAliasMixin should use `restify()` to render the metadata of GenericAlias as py36 does. | ||||
* | Merge branch '3.4.x' into 3.x | Takeshi KOMIYA | 2021-01-01 | 1 | -1/+1 |
|\ | |||||
| * | A happy new year! | Takeshi KOMIYA | 2021-01-01 | 1 | -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 metadata | Takeshi KOMIYA | 2020-12-27 | 1 | -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 class | Takeshi KOMIYA | 2020-12-16 | 1 | -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 GenericAlias | Takeshi KOMIYA | 2020-11-29 | 1 | -0/+26 |
| | |||||
* | Fix #8480: autoattribute could not create document for __slots__ attributes | Takeshi KOMIYA | 2020-11-23 | 1 | -0/+35 |
| | |||||
* | Fix #8460: autodata directive does not display the detail of TypeVars | Takeshi KOMIYA | 2020-11-22 | 1 | -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 attribute | Takeshi KOMIYA | 2020-11-21 | 1 | -0/+15 |
| | |||||
* | Make tests/ a Python package | François Freitag | 2020-11-20 | 1 | -1/+2 |
| | | | | Allows relative imports. | ||||
* | Fix #8443: autoattribute does not support uninitialized ivars | Takeshi KOMIYA | 2020-11-20 | 1 | -0/+30 |
| | |||||
* | autodoc: Fix :no-value: option for autoattribute does not work | Takeshi KOMIYA | 2020-11-17 | 1 | -1/+0 |
| | |||||
* | Rename :novalue: option to :no-value: option | Takeshi KOMIYA | 2020-11-15 | 1 | -0/+42 |
According to the existing options of autodoc directives, `:novalue:` option is now renamed to `:no-value:` option. |