Commit message (Collapse) | Author | Age | Files | Lines | ||
---|---|---|---|---|---|---|
... | ||||||
| * | | Close #6698: doctest: Add :no-trim-doctest-flags: options | Takeshi KOMIYA | 2020-08-05 | 1 | -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 names | Takeshi KOMIYA | 2020-08-02 | 1 | -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 KOMIYA | 2020-08-01 | 1 | -2/+33 | |
|\ \ \ | |/ / | ||||||
| * | | Update CHANGES for PR #7690 | Takeshi KOMIYA | 2020-07-25 | 1 | -0/+2 | |
| | | | ||||||
| * | | Merge pull request #7690 from keewis/transform_numpy_parameter_types | Takeshi KOMIYA | 2020-07-25 | 1 | -2/+31 | |
| |\ \ | | | | | | | | | preprocessing numpy types | |||||
| | * | | add a section about napoleon_type_aliases to the documentation | Keewis | 2020-07-25 | 1 | -1/+30 | |
| | | | | ||||||
| | * | | update the link to the official docstring guide | Keewis | 2020-07-25 | 1 | -1/+1 | |
| | | | | ||||||
* | | | | Merge branch 'mathjax-3' of github.com:hameerabbasi/sphinx into mathjax-3 | Hameer Abbasi | 2020-07-24 | 1 | -1/+1 | |
|\ \ \ \ | ||||||
| * | | | | Change MathJax 2 path string. | Hameer Abbasi | 2020-07-24 | 1 | -1/+1 | |
| | | | | | | | | | | | | | | | Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com> | |||||
* | | | | | Fold line. | Hameer Abbasi | 2020-07-24 | 1 | -1/+2 | |
| | | | | | ||||||
* | | | | | Merge branch 'master' into mathjax-3 | Hameer Abbasi | 2020-07-24 | 1 | -1/+10 | |
|\ \ \ \ \ | |/ / / / |/| / / / | |/ / / | ||||||
| * | | | Merge pull request #7927 from jnothman/name-case-clash | Takeshi KOMIYA | 2020-07-24 | 1 | -0/+9 | |
| |\ \ \ | | |/ / | |/| | | Add autosummary_filename_map config to avoid clashes | |||||
| | * | | Add autosummary_filename_map config to avoid clashes | Joel Nothman | 2020-07-08 | 1 | -0/+9 | |
| | | | | ||||||
| * | | | Update description of autosummary_generate_overwrite | Johannes Lade | 2020-07-13 | 1 | -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 Abbasi | 2020-07-24 | 1 | -2/+3 | |
| | | | ||||||
* | | | Delete repeated word. | Hameer Abbasi | 2020-07-15 | 1 | -1/+1 | |
| | | | | | | | | | Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com> | |||||
* | | | Move to MathJax 3. | Hameer Abbasi | 2020-07-15 | 1 | -2/+6 | |
|/ / | ||||||
* | | napoleon: Add aliases Warn and Raise | Nguyễn Gia Phong | 2020-06-29 | 1 | -0/+2 | |
| | | ||||||
* | | doc: Add modname separator tip for autodoc (refs: #7841) | Takeshi KOMIYA | 2020-06-21 | 1 | -0/+6 | |
| | | ||||||
* | | Fix typo | Takeshi KOMIYA | 2020-06-06 | 1 | -1/+1 | |
| | | ||||||
* | | Merge pull request #7760 from Cielquan/feature/coverage_print_missing_as_warning | Takeshi KOMIYA | 2020-06-06 | 1 | -1/+8 | |
|\ \ | |/ |/| | coverage ext - config to log missing coverage | |||||
| * | documented coverage_show_missing_items confval | Christian Riedel | 2020-06-05 | 1 | -1/+8 | |
| | | ||||||
* | | Close #2106: autodoc: Support multiple signatures on docstring | Takeshi KOMIYA | 2020-05-30 | 1 | -0/+7 | |
|/ | ||||||
* | Update docs (refs: #7469) | Takeshi KOMIYA | 2020-05-21 | 1 | -1/+1 | |
| | ||||||
* | revisions per comments from tk0miya | Daniel Fremont | 2020-05-17 | 1 | -0/+4 | |
| | ||||||
* | Merge remote-tracking branch 'sphinx/3.x' into 3.x | Daniel Fremont | 2020-05-17 | 4 | -7/+65 | |
|\ | ||||||
| * | doc: Fix examples of doctest extensions are still in py2 (refs: #7575) | Takeshi KOMIYA | 2020-04-29 | 1 | -5/+5 | |
| | | ||||||
| * | Close #4030: autosummary: Add autosummary_context | Takeshi KOMIYA | 2020-04-25 | 1 | -0/+7 | |
| | | ||||||
| * | Merge pull request #7473 from eric-wieser/meta-public | Takeshi KOMIYA | 2020-04-23 | 1 | -0/+15 | |
| |\ | | | | | | | Add support for :meta public: | |||||
| | * | Add support for :meta public: | Eric Wieser | 2020-04-14 | 1 | -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 version | Takeshi KOMIYA | 2020-04-21 | 1 | -1/+1 | |
| | | | ||||||
| * | | Remove autosummary_recursive configuration | Takeshi KOMIYA | 2020-04-21 | 1 | -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_recursive | Takeshi KOMIYA | 2020-04-21 | 10 | -11/+138 | |
| |\ \ | ||||||
| | * | | Close #7490: autosummary: Add ``:caption:`` option to autosummary directive | Takeshi KOMIYA | 2020-04-16 | 1 | -0/+6 | |
| | | | | ||||||
| | * | | Fix #7477: imgconverter: Invoke "magick convert" command on Windows | Takeshi KOMIYA | 2020-04-15 | 1 | -0/+12 | |
| | |/ | ||||||
| * | | autosummary: Add :recursive: option to autosummary directive | Takeshi KOMIYA | 2020-04-21 | 1 | -0/+14 | |
| | | | ||||||
| * | | Merge with master and address code review | woutdenolf | 2019-07-08 | 3 | -23/+119 | |
| |\ \ | ||||||
| * | | | [autosummary] remove recursion limit and module/package separation | woutdenolf | 2019-06-02 | 1 | -17/+6 | |
| | | | | ||||||
| * | | | [autosummary] doclint violation | woutdenolf | 2019-06-01 | 1 | -3/+3 | |
| | | | | ||||||
| * | | | Merge branch 'master' into feature-autosummary-packages | woutdenolf | 2019-06-01 | 6 | -17/+38 | |
| |\ \ \ | ||||||
| * \ \ \ | Merge branch 'master' into feature-autosummary-packages | woutdenolf | 2019-05-18 | 4 | -57/+91 | |
| |\ \ \ \ | ||||||
| * | | | | | [autosummary] address code review | woutdenolf | 2019-04-07 | 1 | -34/+12 | |
| | | | | | | ||||||
| * | | | | | Merge branch 'master' into feature-autosummary-packages | woutdenolf | 2019-04-07 | 7 | -12/+53 | |
| |\ \ \ \ \ | ||||||
| | * | | | | | Fix docs of inheritance-diagram "parts" option | Michael Goerz | 2019-03-10 | 1 | -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-packages | woutdenolf | 2019-02-24 | 4 | -4/+28 | |
| |\ \ \ \ \ \ | ||||||
| * | | | | | | | [autosummary] modify docs | woutdenolf | 2019-02-24 | 1 | -5/+42 | |
| | | | | | | | | ||||||
| * | | | | | | | [autosummary] add modules and packages for modules | woutdenolf | 2019-02-08 | 1 | -0/+13 | |
| | | | | | | | | ||||||
* | | | | | | | | updated corresponding documentation | Daniel Fremont | 2020-04-12 | 1 | -2/+2 | |
| |_|_|_|_|_|/ |/| | | | | | | ||||||
* | | | | | | | Correct minor typo | PythonCoderAS | 2020-03-18 | 1 | -1/+1 | |
| | | | | | | | ||||||
* | | | | | | | Close #7079: Make autodoc_typehints=description formal | Takeshi KOMIYA | 2020-03-07 | 1 | -21/+4 | |
| | | | | | | |