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
path: root/sphinx/ext
AgeCommit message (Collapse)Author
2021-03-22Deprecate DocumenterBridge.warn()Takeshi KOMIYA
Since 1.6, sphinx.util.logging module became the default logging interface of Sphinx. It allows sphinx-components to output log without the app (or env) object. According to the policy, DocumenterBridge.warn() is no longer needed and should be replaced by the logging module.
2021-03-20Rename DocumenterBridge.filename_set to record_dependenciesTakeshi KOMIYA
DocumenterBridge.filename_set has been used since its beginning. On the other hand, in docutils, record_dependencies attribute is well-used to store the list of dependency files. So this renames it to docutils' standard attribute.
2021-03-15refactor: Use PEP-526 based variable annotation (sphinx.ext)Takeshi KOMIYA
2021-03-15Merge pull request #8983 from tk0miya/7523_autodoc_propertyTakeshi KOMIYA
Fix #7383: autodoc: Support typehints for properties
2021-03-13Fix #7383: autodoc: Support typehints for propertiesTakeshi KOMIYA
py:property directive now outputs py:property directive to describe its type annotation.
2021-03-13refactor: Add a type alias for the option_spec of directives; OptionSpecTakeshi KOMIYA
2021-03-09Close #7549: autosummary: Enable autosummary_generate by defaultTakeshi KOMIYA
2021-03-06Fix #759: autodoc: Add sphinx.ext.autodoc.preserve_defaults extensionTakeshi KOMIYA
Add a new extension `sphinx.ext.autodoc.preserve_defaults`. It preserves the default argument values of function signatures in source code and keep them not evaluated for readability. This is an experimental extension and it will be integrated into autodoc core in Sphinx-4.0.
2021-03-06intersphinx: Support pending_xref_conditionTakeshi KOMIYA
2021-02-28Merge pull request #8939 from tk0miya/8938_imgconverter_show_OSErrorTakeshi KOMIYA
Fix #8938: imgconverter: Show the error of the command availability check
2021-02-28Merge pull request #8935 from tk0miya/8933_viewcode_backlink_on_parallel_buildTakeshi KOMIYA
Fix #8933: viewcode: Failed to create back-links on parallel build
2021-02-27Fix #8938: imgconverter: Show the error of the command availability checkTakeshi KOMIYA
imgconverter extension suppresses an OSError like "Cannot allocate memory" unexpectedly. So the error should be shown with the warning.
2021-02-25Fix #8933: viewcode: Failed to create back-links on parallel buildTakeshi KOMIYA
On parallel build mode, viewcode losts the back-links information on gathering results from each process. As a result, some back-links are missing in the generated viewcode pages. This fixes the merging back-links process for parallel builds.
2021-02-24Close #8924: autodoc: Support `bound` argument for TypeVarTakeshi KOMIYA
2021-02-16Merge branch '3.x'Takeshi KOMIYA
2021-02-15Fix #8883: autodoc: AttributeError on assigning __annotations__Takeshi KOMIYA
2021-02-15Sometimes _viewcode_modules can be False; don't crash when it isDustin Spicuzza
- Fixes #8880
2021-02-04Merge branch '3.x' into merge_3.x_into_masterjfbu
Resolved Conflicts: sphinx/texinputs/sphinxpackagefootnote.sty
2021-02-04Merge pull request #8297 from pbudzyns/exclude-members-fixTakeshi KOMIYA
Local autodoc options override or extend autodoc_default_options.
2021-02-02Merge branch '3.x' into master_with_merged_3.xjfbu
2021-02-01Fix #8782: todo: Cross references in todolist get brokenTakeshi KOMIYA
On resolving cross reference nodes in todolist, some of them get broken because todo extension does not rewrite the "refdoc" attribute of them.
2021-02-01Fix #8800: autodoc: Uninitialized attributes in superclass are recognized as ↵Takeshi KOMIYA
undocumented Unintentionally, uninitialized attributes defined at superclasses are recognized as undocumented in the filtering step. Therefore, they are filtered if `:undoc-members:` option given.
2021-02-01Merge remote-tracking branch 'upstream/3.x' into exclude-members-fixpbudzyns
2021-02-01check if autodoc_defaults are str, fix testspbudzyns
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-30Merge branch '3.x'Takeshi KOMIYA
2021-01-29code formatpbudzyns
2021-01-29add private-members as extendablepbudzyns
2021-01-29local options handlingpbudzyns
2021-01-27Merge branch '3.x'Takeshi KOMIYA
2021-01-27graphviz: Image node is not rendered if graph file is in subdir (refs: #8232)Takeshi KOMIYA
To support images for graphviz, graphviz commands (ex. dots) should be invoked at the directory placed the graph file.
2021-01-25redundant '+' has no effectpbudzyns
2021-01-25Merge pull request #8757 from tk0miya/8756_viewcode_purge_docTakeshi KOMIYA
Fix #8756: viewcode: highlighted code is generated even if not referenced
2021-01-25add more extendable options and testspbudzyns
2021-01-25add more extendable options and testspbudzyns
2021-01-24Fix #8756: viewcode: highlighted code is generated even if not referencedTakeshi KOMIYA
viewcode does not purge unreferenced modules on incremental build. This adds env-purge-doc handler to clean them.
2021-01-24Merge branch '3.x'Takeshi KOMIYA
2021-01-24Fix #8134: autodoc: crashes when mocked decorator takes argumentsTakeshi KOMIYA
autodoc crashed when a decorator in mocked module takes arguments because mock system returns the first argument for the decorator as a decorated object. This changes the approach for mocking decorators that remembers arguments for each decoration, and fetch the latest argument on generating document.
2021-01-24Merge pull request #8731 from tk0miya/8004_preprocess_types_for_googleTakeshi KOMIYA
Fix #8004: napoleon_preprocess_types for Google style docstrings
2021-01-23Fix #8004: napoleon_preprocess_types for Google style docstringsTakeshi KOMIYA
Type definitions in Google style docstrings are rendered as references when :confval:`napoleon_preprocess_types` enabled.
2021-01-22Fix #8727: apidoc: namespace module file is not generated if no submodulesTakeshi KOMIYA
sphinx-apidoc should generate a namespace module file when `--implicit-namespace` option given. This fixes the case the namespace module has subpackages, but no submodules.
2021-01-22Merge branch '3.x'Takeshi KOMIYA
2021-01-22Fix #8704: viewcode: anchors are generated in incremental buildTakeshi KOMIYA
The anchors for viewcode was generated in the reading phase only if supported builder is used. It causes anchors are missing on the incremental build after the build for non supported builder. This introduces `viewcode_anchor` node to insert the anchor even if non supported builders. They will be converted to the anchor tag in the resolving phase for supported builders. Or, they will be removed for non supported builders.
2021-01-21Fix #8720: viewcode: module pages are generated for epub on incremental buildTakeshi KOMIYA
The module pages should be generated for epub only if enabled via configuration. But they are generated after the build for other viewcode-supported builders. This checks the current builder on generating module pages.
2021-01-20Close #5560: napoleon_use_param also affect "other parameters" sectionTakeshi KOMIYA
2021-01-19refactor: autosummary: Deprecate _simple_info() and _simple_warn()Takeshi KOMIYA
2021-01-19Merge pull request #8703 from tk0miya/refactor_viewcode2Takeshi KOMIYA
refactor: viewcode: Fix type annotations
generated by cgit v1.2.3 (git 2.25.1) at 2024-08-16 17:29:32 +0300