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
Stephen Finucane
375fb52fe4
docs: Add information about Sphinx trove classifiers
...
Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-03 22:45:11 +01:00
Stephen Finucane
e0d3e0aa8c
docs: Update reference to sphinx-contrib organization
...
This is now well established on GitHub and the Bitbucket organization is
no longer maintained. Update the documentation to indicate this.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 21:58:05 +01: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
Daniel Fremont
f9e9bdc4a0
Merge remote-tracking branch 'sphinx/3.x' into 3.x
2020-05-17 08:09:45 -07:00
Takeshi KOMIYA
155cb87452
doc: Fix examples of doctest extensions are still in py2 (refs: #7575 )
2020-04-29 22:46:44 +09:00
Takeshi KOMIYA
037fe96dc1
Close #4030 : autosummary: Add autosummary_context
2020-04-25 11:15:43 +09:00
Takeshi KOMIYA
c9e4945623
Merge pull request #7473 from eric-wieser/meta-public
...
Add support for :meta public:
2020-04-23 02:15:42 +09:00
Takeshi KOMIYA
6e28675727
doc: Fix version
2020-04-21 23:38:18 +09:00
Takeshi KOMIYA
7671bcc23b
Remove autosummary_recursive configuration
...
Now autosummary directive has :recursive: option to enable the
recursive feature individually. So the configuration is no longer
needed.
2020-04-21 23:38:18 +09:00
Takeshi KOMIYA
b9da9237bc
Merge branch '3.x' into 6040_autosummary_recursive
2020-04-21 23:04:38 +09:00
Takeshi KOMIYA
476b73b6ca
autosummary: Add :recursive: option to autosummary directive
2020-04-21 22:47:00 +09:00
Takeshi KOMIYA
dc46897768
Close #7490 : autosummary: Add `:caption:` option to autosummary directive
2020-04-16 23:04:57 +09:00
Takeshi KOMIYA
19d5d8d75c
Fix #7477 : imgconverter: Invoke "magick convert" command on Windows
2020-04-15 23:23:28 +09:00
Eric Wieser
0d7451c23d
Add support for :meta public:
...
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`
2020-04-14 08:41:45 +01:00
Daniel Fremont
8ee7d908f3
updated corresponding documentation
2020-04-12 12:06:14 -07:00
PythonCoderAS
c495b2a380
Correct minor typo
2020-03-18 21:49:41 -04:00
Takeshi KOMIYA
d517aa6c16
Close #7079 : Make autodoc_typehints=description formal
2020-03-07 13:19:37 +09:00
Takeshi KOMIYA
f13c546862
doc: Update docs
2020-03-07 02:00:50 +09:00
Takeshi KOMIYA
448937eb4d
doc: Remove mention about py2
2020-02-24 12:43:00 +09:00
Neal McBurnett
b620a8a6cc
Fix typos
...
bad quoting, better word usage.
2020-02-09 19:12:52 -07:00
Neal McBurnett
9b125cf8e9
Clarify documentation on use of doctest extension
...
When I first read this section, I was mightily confused due to lack of context and the use of the passive voice.
I think this phrasing clarifies the context and indicates more clearly what the documentation author does
vs what the doctest extension and builder do.
But I'm a newbie here, so please ensure that I got this right....
2020-02-09 16:59:39 -07:00
Takeshi KOMIYA
e7a0af807a
Merge branch '2.0'
2020-01-30 23:29:32 +09:00
Takeshi KOMIYA
5397664d42
Add a new extension: sphinx.ext.autodoc.typehints
2020-01-25 17:56:39 +09:00
Takeshi KOMIYA
347e301727
Merge branch '2.0'
2020-01-19 22:47:02 +09:00
Takeshi KOMIYA
74a5f350a1
Add new event: autodoc-before-process-signature
2020-01-13 13:16:59 +09:00
Takeshi KOMIYA
b968bb91e9
Close #6830 : autodoc: consider a member private if docstring has "private" metadata
2020-01-04 13:28:07 +09:00
Takeshi KOMIYA
0319faf8f1
Merge branch '2.0'
2020-01-01 14:40:39 +09:00
Takeshi KOMIYA
2f36d792f3
Update CHANGES for PR #5230
2020-01-01 12:59:20 +09:00
Takeshi KOMIYA
e628afd5cd
Merge branch '2.0'
2020-01-01 11:39:46 +09:00
Takeshi KOMIYA
18e25d680d
Close #6966 : graphviz: Support `:class:` option
2019-12-27 22:38:10 +09:00
Takeshi KOMIYA
1fc4e8c251
Merge branch '2.0'
2019-12-25 22:44:12 +09:00
Takeshi KOMIYA
de9ee3e70a
doc: Fix sphinx.ext.duration will be added since 2.4.0
2019-12-25 22:43:56 +09:00
Takeshi KOMIYA
e83bb29789
Merge pull request #6873 from tk0miya/5923_autodoc_inherited_members_can_ignore_specific_superclass
...
Close #5923 : autodoc: allow not to document inherited members of specific super class
2019-12-22 16:30:56 +09:00
Takeshi KOMIYA
a209002b81
doc: Add examples for :inherited-members:
2019-12-22 16:05:45 +09:00
Takeshi KOMIYA
d47f38e22d
Merge branch '2.0'
2019-12-21 12:21:49 +09:00
Takeshi KOMIYA
29687a29f1
Close #6446 : Add sphinx.ext.durations to inspect durations of build
2019-12-16 00:47:23 +09:00
Takeshi KOMIYA
fb9adbf0be
Merge pull request #6870 from stsewd/update-docs-intersphinx-with-basic-auth
...
Update docs about intersphinx and basic auth support
2019-12-03 01:42:37 +09:00
Santos Gallegos
46c68302be
Be more specific about the type of login
2019-12-02 11:07:17 -05:00
Takeshi KOMIYA
7c79a6b8d1
Close #5923 : autodoc: allow not to document inherited members of specific super class
2019-12-01 12:51:28 +09:00
Takeshi KOMIYA
15c266c445
Merge branch '2.0'
2019-11-30 21:52:42 +09:00
Takeshi KOMIYA
82a6048f12
Fix typo
2019-11-28 23:31:08 +09:00
Santos Gallegos
f7c1e9190a
Linter
2019-11-27 15:38:26 -05:00
Santos Gallegos
a72d8f6808
Update docs about intersphinx and basic auth support
...
This was added in #2089 but the docs don't mention it.
2019-11-27 15:23:52 -05:00
Takeshi KOMIYA
82b2b1752a
doc: URL of numpydoc has changed
2019-11-27 00:12:32 +09:00
Takeshi KOMIYA
66c3dd3adb
Close #6798 : autosummary: emit `autodoc-skip-member` event on generating stub file
2019-11-16 18:19:31 +09:00
Takeshi KOMIYA
01f8dad160
Merge branch '2.0'
2019-08-19 00:37:30 +09:00
jfbu
4ae5414ee5
Update our docs for imgmath_latex (refs: #6610 )
2019-08-03 12:00:24 +02:00
jfbu
47cd262b3e
Merge branch '2.0'
2019-08-01 18:30:48 +02:00
jfbu
7c59e44eaa
Fix version changed info in our document for imgmath
2019-08-01 18:24:28 +02:00
jfbu
da3763170e
Reorganize documentation of the imgmath configuration variables
2019-08-01 17:52:28 +02:00
jfbu
505ff622c2
More robust code for getting saved "depth" of svg inline math snippet
2019-08-01 17:52:28 +02:00
jfbu
1adf12bfa7
Make imgmath_use_preview work also for svg output
2019-08-01 17:52:28 +02:00
woutdenolf
9dc9b8754d
Merge with master and address code review
2019-07-08 08:29:23 +02:00
Takeshi KOMIYA
4af90fcf75
Fix #247 : autosummary: Add autosummary_generate_option to overwrite old stub file
2019-07-07 16:18:49 +09:00
