summaryrefslogtreecommitdiff
path: root/sphinx/ext
Commit message (Collapse)AuthorAgeFilesLines
...
* Merge pull request #10386 from mxd4/10384-comment-img-magickTakeshi KOMIYA2022-05-221-3/+7
|\ | | | | Add comments on ImageMagick requirement
| * #10384 - Remove comment in testmxd42022-05-021-2/+2
| |
| * #10384 - Fix typomxd42022-05-021-1/+1
| |
| * #10384 - Fix flake8mxd42022-05-021-3/+4
| |
| * #10384 - Explicit warning and improve doc claritymxd42022-05-021-3/+6
| |
* | Merge branch '5.0.x' into 9648_autodoc_typehints_description_and_stared_argsTakeshi KOMIYA2022-05-221-2/+10
|\ \
| * | Fix #9575: autodoc: Return annotation should not be shownTakeshi KOMIYA2022-05-151-2/+10
| | |
* | | Fix #9648: autodoc: *args and **kwargs entries are duplicatedTakeshi KOMIYA2022-05-151-3/+17
|/ / | | | | | | | | | | | | | | | | In basic usage of autodoc (docstring), `args` and `kwargs` arguments are marked up without stars. But numpydoc style recommends to mark them up with stars. This adds support for starred arguments in docstrings to `autodoc_typehints` feature.
* | Merge pull request #10427 from ↵Takeshi KOMIYA2022-05-081-1/+12
|\ \ | | | | | | | | | | | | tk0miya/10421_autodoc_preserve_defaults_for_classmethod Fix #10421: autodoc_preserve_defaults doesn't work on class methods
| * | Fix #10421: autodoc_preserve_defaults doesn't work on class methodsTakeshi KOMIYA2022-05-081-1/+12
| | |
* | | Merge remote-tracking branch 'origin/5.x' into HEADTakeshi KOMIYA2022-05-0713-387/+69
|\ \ \
| * | | autosummary: global variables having doc-comment are considered as ↵Takeshi KOMIYA2022-05-071-2/+4
| | | | | | | | | | | | | | | | non-imported members of the module
| * | | Fix a flake8 warningTakeshi KOMIYA2022-05-071-1/+0
| | | |
| * | | Merge branch '5.x' into 10258_autosummaryTakeshi KOMIYA2022-05-0731-762/+266
| |\ \ \
| | * | | Fix typoTakeshi KOMIYA2022-05-071-1/+1
| | |/ /
| | * | Merge branch '5.x' into fix-warningsAdam Turner2022-05-022-3/+6
| | |\ \ | | | |/ | | | | | | | | | | | | # Conflicts: # tests/test_search.py
| | | * Fix #10200: apidoc: Duplicated submodules are shown for modulesTakeshi KOMIYA2022-04-301-0/+1
| | | |
| | | * Remove a trailing whitespaceTakeshi KOMIYA2022-04-241-1/+1
| | | |
| | | * Correct autodoc docstringsOscar Gustafsson2022-04-201-3/+5
| | | | | | | | | | | | | | | | | | | | A bit too much copy and paste in the earlier ones. `*-members` also includes `inherited-members` and `exclude-members` which are not dealt with.
| | * | Use `Node.findall`Adam Turner2022-04-221-1/+1
| | | |
| | * | `rawsource` is deprecated in `docutils.nodes.Text`Adam Turner2022-04-221-2/+2
| | | |
| | * | Specify encodingAdam Turner2022-04-223-7/+8
| | |/
| | * Review commentsAdam Turner2022-04-171-1/+1
| | |
| | * Remove deprecated code for Sphinx 5.0Adam Turner2022-04-177-371/+45
| | |
| * | Do not pass attr_docs as an argument into ModuleScanner.scanMatyas Novak2022-03-141-4/+6
| | |
| * | Recognize a documented attribute of a module as non-imported.Matyas Novak2022-03-111-5/+6
| | |
* | | Apply `autodoc_typehints_format` to all type hintszuqq2022-04-081-4/+18
| |/ |/| | | | | Specifically: attributes, data, properties, and type variable bounds.
* | Merge pull request #10285 from jmp1985/masterTakeshi KOMIYA2022-04-051-4/+4
|\ \ | | | | | | Fixed singledispatch documentation
| * | Removed white spaceJames Parkhurst2022-03-211-1/+1
| | |
| * | Fixed singledispatch documentationJames Parkhurst2022-03-211-4/+4
| | |
* | | Merge branch '5.x' into autodoc_force_undocumented_rtypeTakeshi KOMIYA2022-04-031-4/+8
|\ \ \
| * | | Close #8417: autodoc: :inherited-members: option now takes multiple classesTakeshi KOMIYA2022-04-031-4/+8
| | | | | | | | | | | | | | | | | | | | It allows to suppress inherited members of several classes on the module at once by specifying the option to `automodule` directive
* | | | autodoc_typehints_description_target: Rename ↵Takeshi KOMIYA2022-04-032-3/+2
| | | | | | | | | | | | | | | | returnvalue_and_documented_params to documented_params
* | | | Merge branch '5.x' into autodoc_force_undocumented_rtypeTakeshi KOMIYA2022-04-0331-541/+605
|\ \ \ \ | |/ / /
| * | | Merge pull request #10321 from ↵Takeshi KOMIYA2022-04-031-1/+5
| |\ \ \ | | | | | | | | | | | | | | | | | | | | tk0miya/10266_autodoc_preserve_defaults_crashes_on_kwonlyargs_without_defaults Fix #10266: autodoc_preserve_defaults crashes on kwonlyargs w/o defaults
| | * \ \ Merge branch '5.x' into ↵Takeshi KOMIYA2022-04-031-0/+14
| | |\ \ \ | | | | | | | | | | | | | | | | | | 10266_autodoc_preserve_defaults_crashes_on_kwonlyargs_without_defaults
| | * | | | Fix #10266: autodoc_preserve_defaults crashes on kwonlyargs w/o defaultsTakeshi KOMIYA2022-04-021-1/+5
| | | | | |
| * | | | | Merge pull request #10313 from ↵Takeshi KOMIYA2022-04-031-3/+9
| |\ \ \ \ \ | | |_|/ / / | |/| | | | | | | | | | | | | | | | GutiCW/feature-support_mocked_decorator_for_class_methods Support mocked decorator for class methods
| | * | | | Reduce complexity by removing recursion.Christian Walch2022-04-011-2/+4
| | | | | |
| | * | | | Move method `isboundmethod()` into sphinx/util/inspect.py.Christian Walch2022-04-011-9/+1
| | | | | |
| | * | | | Rename function `_method_is_bound()` -> `isboundmethod()`.Christian Walch2022-04-011-2/+2
| | | | | |
| | * | | | Add types and docstring to function `_method_is_bound()`.Christian Walch2022-03-311-1/+2
| | | | | |
| | * | | | Add unwittingly removed empty line.Christian Walch2022-03-311-0/+1
| | | | | |
| | * | | | Use recursive call to `ismock()` on unbound method instead of using ↵Christian Walch2022-03-311-4/+2
| | | | | | | | | | | | | | | | | | | | | | | | temporary object.
| | * | | | Closes #10310: Sphinx automodule: class method not documented when decorated ↵Christian Walch2022-03-311-3/+15
| | | | | | | | | | | | | | | | | | | | | | | | with mocked function.
| * | | | | Fix #10280: autodoc_docstring_signature generates needless return typehintTakeshi KOMIYA2022-04-031-0/+14
| | |/ / / | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | Basically, autodoc suppresses return value typehint for class constructors. But it was unexpectedly shown if `autodoc_docstring_signature` is enabled and docstring has multiple signatures.
| * | | | Merge branch '4.x'Takeshi KOMIYA2022-03-281-1/+8
| |\ \ \ \ | | |/ / /
| | * | | Merge pull request #10263 from nicoa/escape_base_uri_in_extlinksTakeshi KOMIYA2022-03-281-1/+8
| | |\ \ \ | | | | | | | | | | | | escape base_uri in extlinks
| | | * | | Fix a flake8 warningTakeshi KOMIYA2022-03-271-1/+2
| | | | | |
| | | * | | extlink: Strip a leading backslash on compiling patternTakeshi KOMIYA2022-03-271-1/+7
| | | | | |
View Lorry Controller Status