Takeshi KOMIYA
5ce72f465b
Merge branch '3.x'
2021-01-22 22:52:32 +09:00
Takeshi KOMIYA
ca0677086d
Merge pull request #8658 from SolidifiedRay/feature-custom-section
...
Close #8573 : napoleon: Add more custom section styles
2021-01-19 21:13:13 +09:00
SolidifiedRay
7ad85cd1e0
Close #8573 : napoleon: Add more custom section styles
2021-01-18 11:43:40 -08:00
Takeshi KOMIYA
30f8640bab
Merge branch '3.x'
2021-01-16 21:51:46 +09:00
Takeshi KOMIYA
f433581b04
doc: Fix highlight language
2021-01-10 22:22:30 +09:00
Takeshi KOMIYA
a9c7dd7037
Merge branch '3.x'
2021-01-03 00:20:27 +09:00
Hong Xu
1f020196a7
DOC: modules are only available when recursive is on
...
See
7ecf6b88aa/sphinx/ext/autosummary/generate.py (L314-L315)
2021-01-01 11:12:58 -08:00
Takeshi KOMIYA
a122397b4b
Merge branch '3.x'
2020-12-29 18:37:45 +09:00
Hong Xu
d9ca895dbb
Update autodoc.rst
2020-12-27 21:24:19 -08:00
Hong Xu
6927130ff1
Doc: Correct type: "TypeAlias" -> "AliasType"
2020-12-27 21:23:31 -08:00
Takeshi KOMIYA
9e9e486e65
Close #8022 : autodoc: Allow to hide the value of the variables via metadata
...
autodata and autoattribute directives does not show right-hand value of
the variable if its docstring contains ``:meta hide-value:`` in
info-field-list.
2020-12-27 12:46:03 +09:00
Takeshi KOMIYA
2c98e909bf
Merge branch '3.x'
2020-12-14 02:02:29 +09:00
Ned Batchelder
bac6ab8d0c
Describe the intersphinx mapping a bit more
2020-12-13 08:04:55 -05:00
Quentin Soubeyran
ec30f77712
refactored code and tests, prepared for numpy feature
2020-11-25 08:45:25 +01:00
Quentin Soubeyran
f268665292
added napoleon_google_attr_annotations option to use PEP 526 on google style
2020-11-25 08:45:25 +01:00
Takeshi KOMIYA
3a4ae2092a
Merge branch '3.x'
2020-11-21 01:01:36 +09:00
Takeshi KOMIYA
5676fdeb4e
Rename :novalue: option to :no-value: option
...
According to the existing options of autodoc directives, `:novalue:`
option is now renamed to `:no-value:` option.
2020-11-15 14:20:30 +09:00
Marlon James
6082ce67a4
autodoc: document :novalue: option
2020-11-15 14:19:33 +09:00
Takeshi KOMIYA
598b85da75
Merge branch '3.x' into master
2020-10-04 22:41:44 +09:00
François Freitag
5166dd194c
Strip trailing whitespaces and normalize line endings
...
Trailing whitespace do not have impact on the result, they are just
unused bytes. Most text editors are configured to strip trailing
whitespaces. Remove them all in one go.
Update a handful of files to use the UNIX line ending.
2020-10-03 13:47:01 +02:00
Takeshi KOMIYA
f2c0dfe7c4
Close #6518 : autodoc: Add autodoc_type_aliases
...
autodoc_type_aliases allows to keep user defined type alises not
evaluated in the generated document.
2020-10-03 16:03:35 +09:00
Takeshi KOMIYA
26ea870267
Merge branch '3.x' into master
2020-10-03 13:43:21 +09:00
Bradley Dice
a0116eaa58
Fix typo: anchestor -> ancestor.
2020-09-20 17:36:01 -05:00
Adam J. Stewart
fa8ad979af
sphinx.ext.autodoc: fix typo in docs
2020-08-11 11:05:00 -05:00
Takeshi KOMIYA
a8927bcd3e
Merge branch '3.x'
2020-08-08 18:16:59 +09:00
Takeshi KOMIYA
059dc108ba
Close #6698 : doctest: Add :no-trim-doctest-flags: options
...
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 ).
2020-08-05 23:39:05 +09:00
Takeshi KOMIYA
d7a84e83cc
Close #8034 : autodoc: :private-member: can take an list of member names
...
Now :private-member: option can take an explicit list of member names to
be documented as its arguments (like :special-members: does).
2020-08-02 01:27:14 +09:00
Takeshi KOMIYA
c14c00397e
Merge branch '3.x'
2020-08-01 16:59:00 +09:00
Takeshi KOMIYA
778e297577
Update CHANGES for PR #7690
2020-07-25 21:45:13 +09:00
Takeshi KOMIYA
ac0a800265
Merge pull request #7690 from keewis/transform_numpy_parameter_types
...
preprocessing numpy types
2020-07-25 21:41:32 +09:00
Keewis
6ae1c601b9
add a section about napoleon_type_aliases to the documentation
2020-07-25 11:49:58 +02:00
Keewis
530793d997
update the link to the official docstring guide
2020-07-25 11:37:32 +02:00
Hameer Abbasi
a4413810bc
Merge branch 'mathjax-3' of github.com:hameerabbasi/sphinx into mathjax-3
2020-07-24 17:01:39 +02:00
Hameer Abbasi
8f5ce152a1
Fold line.
2020-07-24 16:59:40 +02:00
Hameer Abbasi
98d3ed01ff
Merge branch 'master' into mathjax-3
2020-07-24 16:58:55 +02:00
Hameer Abbasi
496ac3fe8b
Change MathJax 2 path string.
...
Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>
2020-07-24 12:31:23 +02:00
Hameer Abbasi
aed8f719ca
Expand warning and refer to it from CHANGES.
2020-07-24 11:52:30 +02:00
Takeshi KOMIYA
da174138af
Merge pull request #7927 from jnothman/name-case-clash
...
Add autosummary_filename_map config to avoid clashes
2020-07-24 01:07:19 +09:00
Hameer Abbasi
72f3592796
Delete repeated word.
...
Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>
2020-07-15 14:39:56 +02:00
Hameer Abbasi
436519743b
Move to MathJax 3.
2020-07-15 13:09:08 +02:00
Johannes Lade
91285f39a6
Update description of autosummary_generate_overwrite
...
The old description was confusing. Maybe it's just me not being a native speaker, but I think it was wrongly worded.
2020-07-13 14:03:06 +02:00
Joel Nothman
72ca2bdffc
Add autosummary_filename_map config to avoid clashes
2020-07-08 16:51:57 +10:00
Nguyễn Gia Phong
1a865069db
napoleon: Add aliases Warn and Raise
2020-06-29 22:19:54 +07:00
Takeshi KOMIYA
42f29b6acf
doc: Add modname separator tip for autodoc (refs: #7841 )
2020-06-21 23:28:03 +09:00
Takeshi KOMIYA
2fb5232b12
Fix typo
2020-06-06 01:21:35 +09:00
Takeshi KOMIYA
07d19ebe02
Merge pull request #7760 from Cielquan/feature/coverage_print_missing_as_warning
...
coverage ext - config to log missing coverage
2020-06-06 01:13:41 +09:00
Christian Riedel
f33eb15b83
documented coverage_show_missing_items confval
2020-06-05 17:42:26 +02:00
Takeshi KOMIYA
800dcf0f0a
Close #2106 : autodoc: Support multiple signatures on docstring
2020-05-30 15:40:21 +09:00
Takeshi KOMIYA
752d3285d2
Update docs (refs: #7469 )
2020-05-21 00:56:32 +09:00
Daniel Fremont
de4aca857c
revisions per comments from tk0miya
2020-05-17 09:07:11 -07:00
