Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/sphinx-doc/sphinx.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
AgeCommit message (Collapse)Author
2021-03-17Fix #8992: autodoc: Failed to resolve types.TracebackType type annotationTakeshi KOMIYA
The builtin module, ``types.TracebackType`` does not have correct module name. This allows to refer it automatically.
2021-03-13refactor: Add a type alias for the option_spec of directives; OptionSpecTakeshi KOMIYA
2021-03-09refactor: Use PEP-526 based variable annotation (sphinx.util)Takeshi KOMIYA
2021-03-06Merge branch '3.x'Takeshi KOMIYA
2021-03-06Fix #7199: py domain: Add a new confval: python_use_unqualified_type_namesTakeshi KOMIYA
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.
2021-03-05Filter pending_xref_condition node on failed resolutionTakeshi KOMIYA
2021-03-04Fix #8952: Exceptions raised in a Directive cause parallel builds to hangTakeshi KOMIYA
Do shutdown explicitly when failure on the subprocess.
2021-02-28autodoc: an imported TypeVar is not resolved (refs: #8415)Takeshi KOMIYA
So far, a TypeVar is rendered without module name. As a result, it could not be resolved if it is imported from other modules. This prepends its module name and make it resolvable. This is available only in Python 3.7 or above. As a side effect, all of TypeVars are displayed with module name. It should be fixed in latter step (refs: #7119)
2021-02-25Fix #8917: autodoc: Raises a warning if function has wrong __globals__ valueTakeshi KOMIYA
`sphinx.util.inspect:signature()` crashes with AttributeError when subject has wrong `__globals__` value. This ignores the error on building.
2021-02-17refactor: Remove meaningless type annotationsTakeshi KOMIYA
2021-02-09Update type annotationsTakeshi KOMIYA
2021-02-02Merge branch '3.x' into master_with_merged_3.xjfbu
2021-02-01Fix #8775: Avoid the crash of autodoc caused by type union operatorTakeshi KOMIYA
The type union operator (PEP-604) causes autodoc crashed in python 3.9 or below because of the syntax is not suppoerted yet in the interpreters. Internally, `typing.get_type_hints()` raises TypeError on evaluating the annotation by BitOr operator for types. To avoid the crash, this adds a fallback not to evaluate the annotations and keep as is. As a side effect, `autodoc_type_aliases` will not work for the modules and classes that uses type union operator for their annotations.
2021-02-01Merge pull request #8803 from tk0miya/8775_autodoc_type_union_operatorTakeshi KOMIYA
autodoc: Support type union operator (PEP-604) (refs: #8775)
2021-01-31autodoc: Support type union operator (PEP-604) (refs: #8775)Takeshi KOMIYA
Upgrade autodoc to support type union operator introduced in PEP-604. It's available only with python 3.10+.
2021-01-31refactor: AttributeError handling for getslots() is not neededTakeshi KOMIYA
2021-01-31refactor: AttributeError handling for getall() is not neededTakeshi KOMIYA
2021-01-31refactor: AttributeError handling for getannotations() is not neededTakeshi KOMIYA
2021-01-31refactor: AttributeError handling for getmro() is not neededTakeshi KOMIYA
Internally, sphinx.util.inspect.getmro() uses `safe_getattr()` with the `default` keyword. Therefore it never raises AttributeError even if the subject raises an error on accessing `__mro__` attribute. This fixes the wrong its usage.
2021-01-23Merge branch 'master' into 8510_html_logo_urlTakeshi KOMIYA
2021-01-23refactor: Add sphinx.util:isurl()Takeshi KOMIYA
2021-01-22Merge branch '3.x'Takeshi KOMIYA
2021-01-22Merge branch '3.4.x' into 3.xTakeshi KOMIYA
2021-01-22Fix mypy violations (with mypy-0.800)Takeshi KOMIYA
2021-01-16Fix #8693: autodoc: Default values for overloads are rendered as stringTakeshi KOMIYA
The default values for overloaded functions are rendered as string literal unexpectedly because autodoc extracts code snippets from the source code, not actual value (ex. int, ellipsis, and so on). This introduces a simple wrapper class; `DefaultValue` to render these code snippets like actual values, not string literals.
2021-01-16Merge branch '3.x'Takeshi KOMIYA
2021-01-12Fix #8683: html_last_updated_fmt generates wrong time zone for %ZTakeshi KOMIYA
sphinx.util.i18n:format_date() converts '%Z' to full name of time zone unexpectedly. It should be converted to short name.
2021-01-12Fix #8683: html_last_updated_fmt does not support UTC offset (%z)Takeshi KOMIYA
sphinx.util.i18n:format_date() does not support %z so far. This adds a mapping for %z to the babel form 'ZZZ'.
2021-01-02refactor: Do not import sphinx.util.smartypants because of deprecatedTakeshi KOMIYA
2021-01-01Merge branch '3.x'Takeshi KOMIYA
2021-01-01Merge branch '3.4.x' into 3.xTakeshi KOMIYA
2021-01-01Merge branch '3.x'Takeshi KOMIYA
2021-01-01A happy new year!Takeshi KOMIYA
.. 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
2020-12-31Fix #8315: autodoc: Failed to resolve struct.Struct type annotationTakeshi KOMIYA
The builtin module, ``struct.Struct`` does not have correct module name since Python 3.8. This allows to refer it automatically.
2020-12-29Merge branch '3.x'Takeshi KOMIYA
2020-12-21doc: Update docstring of getslots()Takeshi KOMIYA
2020-12-21Fix #8559: AttributeError is raised when using ForwardRefTakeshi KOMIYA
The restify() helper crashes when ForwardRef is passed.
2020-12-20Fix a flake8 violationTakeshi KOMIYA
2020-12-20Merge branch '3.x'Takeshi KOMIYA
2020-12-20Merge pull request #8551 from tk0miya/8365_pydomain_xref_missing_contextTakeshi KOMIYA
Fix #8365: py domain: :type: and :rtype: gives false ambiguous warnings
2020-12-19Fix #8365: py domain: :type: and :rtype: gives false ambiguous warningsTakeshi KOMIYA
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.
2020-12-16refactor: Move _getmro() to sphinx.util.inspect moduleTakeshi KOMIYA
2020-12-13Deprecate sphinx.util.osutil.movefile() in favor of os.replace()Jon Dufresne
The utility function movefile() was added in 677d096393bca948eea8fad252bd859ed8142309 to handle existing files on Windows. Since Python 3.3, the stdlib function os.replace() fills this role.
2020-12-13Merge branch '3.x'Takeshi KOMIYA
2020-12-12refactor: pretty change for isproperty()Takeshi KOMIYA
It is more readable to use `>=` to compare versions.
2020-11-28Merge pull request #8291 from ↵Takeshi KOMIYA
QuentinSoubeyran/8285_napoleon_google_style_use_annotations Fix #8285: napoleon can use PEP526 annotations
2020-11-25refactored code and tests, prepared for numpy featureQuentin Soubeyran
2020-11-24refactor with pyupgradeTakeshi KOMIYA
Run `pyupgrade --py3-only --keep-percent-format` to refine our code. Note: --keep-percent-format is required to keep translations available.
2020-11-23explicitly specify encoding=utf-8 in apidocwolfpan
2020-11-22Fix importing errorTakeshi KOMIYA