summaryrefslogtreecommitdiff
path: root/doc/usage/extensions
Commit message (Collapse)AuthorAgeFilesLines
...
| * | Close #6698: doctest: Add :no-trim-doctest-flags: optionsTakeshi KOMIYA2020-08-051-3/+18
| | | | | | | | | | | | | | | | | | | | | To control trimming doctest flags manually, this adds new options :trim-doctest-flags: and :no-trim-doctest-flags: to doctest directives. It helps to describes doctest module itself in python doc (see #6698).
| * | Close #8034: autodoc: :private-member: can take an list of member namesTakeshi KOMIYA2020-08-021-1/+14
| | | | | | | | | | | | | | | Now :private-member: option can take an explicit list of member names to be documented as its arguments (like :special-members: does).
* | | Merge branch '3.x'Takeshi KOMIYA2020-08-011-2/+33
|\ \ \ | |/ /
| * | Update CHANGES for PR #7690Takeshi KOMIYA2020-07-251-0/+2
| | |
| * | Merge pull request #7690 from keewis/transform_numpy_parameter_typesTakeshi KOMIYA2020-07-251-2/+31
| |\ \ | | | | | | | | preprocessing numpy types
| | * | add a section about napoleon_type_aliases to the documentationKeewis2020-07-251-1/+30
| | | |
| | * | update the link to the official docstring guideKeewis2020-07-251-1/+1
| | | |
* | | | Merge branch 'mathjax-3' of github.com:hameerabbasi/sphinx into mathjax-3Hameer Abbasi2020-07-241-1/+1
|\ \ \ \
| * | | | Change MathJax 2 path string.Hameer Abbasi2020-07-241-1/+1
| | | | | | | | | | | | | | | Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>
* | | | | Fold line.Hameer Abbasi2020-07-241-1/+2
| | | | |
* | | | | Merge branch 'master' into mathjax-3Hameer Abbasi2020-07-241-1/+10
|\ \ \ \ \ | |/ / / / |/| / / / | |/ / /
| * | | Merge pull request #7927 from jnothman/name-case-clashTakeshi KOMIYA2020-07-241-0/+9
| |\ \ \ | | |/ / | |/| | Add autosummary_filename_map config to avoid clashes
| | * | Add autosummary_filename_map config to avoid clashesJoel Nothman2020-07-081-0/+9
| | | |
| * | | Update description of autosummary_generate_overwriteJohannes Lade2020-07-131-1/+1
| |/ / | | | | | | The old description was confusing. Maybe it's just me not being a native speaker, but I think it was wrongly worded.
* | | Expand warning and refer to it from CHANGES.Hameer Abbasi2020-07-241-2/+3
| | |
* | | Delete repeated word.Hameer Abbasi2020-07-151-1/+1
| | | | | | | | | Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>
* | | Move to MathJax 3.Hameer Abbasi2020-07-151-2/+6
|/ /
* | napoleon: Add aliases Warn and RaiseNguyễn Gia Phong2020-06-291-0/+2
| |
* | doc: Add modname separator tip for autodoc (refs: #7841)Takeshi KOMIYA2020-06-211-0/+6
| |
* | Fix typoTakeshi KOMIYA2020-06-061-1/+1
| |
* | Merge pull request #7760 from Cielquan/feature/coverage_print_missing_as_warningTakeshi KOMIYA2020-06-061-1/+8
|\ \ | |/ |/| coverage ext - config to log missing coverage
| * documented coverage_show_missing_items confvalChristian Riedel2020-06-051-1/+8
| |
* | Close #2106: autodoc: Support multiple signatures on docstringTakeshi KOMIYA2020-05-301-0/+7
|/
* Update docs (refs: #7469)Takeshi KOMIYA2020-05-211-1/+1
|
* revisions per comments from tk0miyaDaniel Fremont2020-05-171-0/+4
|
* Merge remote-tracking branch 'sphinx/3.x' into 3.xDaniel Fremont2020-05-174-7/+65
|\
| * doc: Fix examples of doctest extensions are still in py2 (refs: #7575)Takeshi KOMIYA2020-04-291-5/+5
| |
| * Close #4030: autosummary: Add autosummary_contextTakeshi KOMIYA2020-04-251-0/+7
| |
| * Merge pull request #7473 from eric-wieser/meta-publicTakeshi KOMIYA2020-04-231-0/+15
| |\ | | | | | | Add support for :meta public:
| | * Add support for :meta public:Eric Wieser2020-04-141-0/+15
| | | | | | | | | | | | | | | | | | | | | | | | A common use case for this is a class like `namedtuple`, which has a public `_replace` method that is so-named in order not to conflict with arbitrary user-provided attributes. Rejected spellings include: * `:meta not-private:` * `:meta private: False`
| * | doc: Fix versionTakeshi KOMIYA2020-04-211-1/+1
| | |
| * | Remove autosummary_recursive configurationTakeshi KOMIYA2020-04-211-15/+1
| | | | | | | | | | | | | | | | | | Now autosummary directive has :recursive: option to enable the recursive feature individually. So the configuration is no longer needed.
| * | Merge branch '3.x' into 6040_autosummary_recursiveTakeshi KOMIYA2020-04-2110-11/+138
| |\ \
| | * | Close #7490: autosummary: Add ``:caption:`` option to autosummary directiveTakeshi KOMIYA2020-04-161-0/+6
| | | |
| | * | Fix #7477: imgconverter: Invoke "magick convert" command on WindowsTakeshi KOMIYA2020-04-151-0/+12
| | |/
| * | autosummary: Add :recursive: option to autosummary directiveTakeshi KOMIYA2020-04-211-0/+14
| | |
| * | Merge with master and address code reviewwoutdenolf2019-07-083-23/+119
| |\ \
| * | | [autosummary] remove recursion limit and module/package separationwoutdenolf2019-06-021-17/+6
| | | |
| * | | [autosummary] doclint violationwoutdenolf2019-06-011-3/+3
| | | |
| * | | Merge branch 'master' into feature-autosummary-packageswoutdenolf2019-06-016-17/+38
| |\ \ \
| * \ \ \ Merge branch 'master' into feature-autosummary-packageswoutdenolf2019-05-184-57/+91
| |\ \ \ \
| * | | | | [autosummary] address code reviewwoutdenolf2019-04-071-34/+12
| | | | | |
| * | | | | Merge branch 'master' into feature-autosummary-packageswoutdenolf2019-04-077-12/+53
| |\ \ \ \ \
| | * | | | | Fix docs of inheritance-diagram "parts" optionMichael Goerz2019-03-101-6/+47
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The documentation now correctly describes the behavior of the ``parts`` option in an inheritance-diagram directive: it gives the number of parts that are *kept* not dropped. The option now also accepts negative values, which drops parts from the left (which is the what the documentation incorrectly claimed the option would do for positive values) As a form of testing of the new functionality, the documentation for the inheritance_diagram extension now includes a section "Examples" that demonstrate the different possibilities. This would fail to build without the patch. Closes #4872
| * | | | | | Merge branch 'master' into feature-autosummary-packageswoutdenolf2019-02-244-4/+28
| |\ \ \ \ \ \
| * | | | | | | [autosummary] modify docswoutdenolf2019-02-241-5/+42
| | | | | | | |
| * | | | | | | [autosummary] add modules and packages for moduleswoutdenolf2019-02-081-0/+13
| | | | | | | |
* | | | | | | | updated corresponding documentationDaniel Fremont2020-04-121-2/+2
| |_|_|_|_|_|/ |/| | | | | |
* | | | | | | Correct minor typoPythonCoderAS2020-03-181-1/+1
| | | | | | |
* | | | | | | Close #7079: Make autodoc_typehints=description formalTakeshi KOMIYA2020-03-071-21/+4
| | | | | | |