Adam Turner
1252c7b549
Use "rst" consistently for code and highlighting directives
2024-07-15 02:15:52 +01:00
Adam Turner
1cfb68d8be
Consistently name the object description options ( #11533 )
...
* The directive option ``:noindex:`` was renamed to ``:no-index:``.
* The directive option ``:noindexentry:`` was renamed to ``:no-index-entry:``.
* The directive option ``:nocontentsentry:`` was renamed to ``:no-contents-entry:``.
The previous names are retained as aliases, but will be deprecated
and removed in a future version of Sphinx (9.0 or later).
2023-07-28 22:30:26 +01:00
Tim Hoffmann
ec26c2f874
Document autosummary template variable "objtype" ( #11044 )
2023-01-02 18:38:17 +00:00
Adam Turner
ee005caf22
Do not apply epigraph style to all block quotes
...
Correct indentation where appropriate for stanzas that should not be
rendered as `<blockquote>` HTML elements.
Closes GH-10686
2022-09-12 19:54:36 +01:00
marxin
9a30edac7d
Fix indentation of .. version{changed,added}.
2022-07-19 15:26:57 +02:00
Timo Cornelius Metzger
8f39f29725
Update autosummary.rst
2022-01-27 20:22:45 -08:00
Josh Mitchell
79089b5fa4
Corrections from review by tk0miya
2021-11-15 13:18:47 +11:00
Josh Mitchell
ad0071ddb7
#2021 : Allow autosummary to respect __all__
2021-11-15 13:16:33 +11:00
Juan Luis Cano Rodríguez
a606db01f1
Add section on autosummary
2021-08-12 20:09:50 +02:00
igo95862
cfa449624d
doc: Moved Jinja links to new home page and HTTPS
...
Seems like Jinja is no longer pocoo project but
palletsprojects.com
2021-05-17 20:38:48 +03:00
Takeshi KOMIYA
54886fd256
Close #7549 : autosummary: Enable autosummary_generate by default
2021-03-10 01:35:49 +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
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
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
037fe96dc1
Close #4030 : autosummary: Add autosummary_context
2020-04-25 11:15:43 +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
Daniel Fremont
8ee7d908f3
updated corresponding documentation
2020-04-12 12:06:14 -07:00
Takeshi KOMIYA
f13c546862
doc: Update docs
2020-03-07 02:00:50 +09:00
Takeshi KOMIYA
15c266c445
Merge branch '2.0'
2019-11-30 21:52:42 +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
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
woutdenolf
ec8656bd27
[autosummary] remove recursion limit and module/package separation
2019-06-02 16:26:40 +02:00
woutdenolf
4fb58b2146
[autosummary] doclint violation
2019-06-01 13:08:23 +02:00
woutdenolf
1a67b87910
Merge branch 'master' into feature-autosummary-packages
2019-05-18 14:42:34 +02:00
woutdenolf
6e0b0517c0
[autosummary] address code review
2019-04-07 12:00:57 +02:00
woutdenolf
4004dd5635
Merge branch 'master' into feature-autosummary-packages
2019-04-07 10:32:57 +02:00
Takeshi KOMIYA
005913630f
Add missing versionadded for autosummary_mock_imports
2019-04-04 23:49:43 +09:00
tsanikgr
eb03b1406f
Simplify docs
2019-04-03 17:31:16 +01:00
tsanikgr
bec116a3b6
#5877 : Allow setting imported_members for autosummary in conf.py
2019-03-27 14:19:16 +00:00
Takeshi KOMIYA
ceef713e79
docs: Remove a term "new" from config values
2019-02-27 01:18:57 +09:00
woutdenolf
33e7b76c32
Merge branch 'master' into feature-autosummary-packages
2019-02-24 12:16:52 +01:00
woutdenolf
cb51216cac
[autosummary] modify docs
2019-02-24 12:12:33 +01:00
Takeshi KOMIYA
73b8d6ff33
Closes #5636 : autosummary: Add autosummary_mock_imports to mock external libraries
2019-02-11 23:19:25 +09:00
woutdenolf
555e675947
[autosummary] add modules and packages for modules
2019-02-08 16:10:43 +01:00
Takeshi KOMIYA
daac35cda7
doc: Add versionadded label (refs: #5029 )
2018-09-03 10:46:38 +09:00
Stephen Finucane
d9ccc95717
doc: Add "extensions" to usage guide
...
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:30:47 +01:00
