154 Commits

Author	SHA1	Message	Date
Steve Piercy	cef669cb0f	Update the link to the new sphinx-contrib organization ... This should be backported to at least 3.x, too.	2021-01-23 17:28:35 +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	f433581b04	doc: Fix highlight language	2021-01-10 22:22:30 +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
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
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	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
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
Bradley Dice	a0116eaa58	Fix typo: anchestor -> ancestor.	2020-09-20 17:36:01 -05: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	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
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
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
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