Commit Graph

423 Commits

Author SHA1 Message Date
Takeshi KOMIYA
897be0ebae Close #7784: i18n: The alt text for image is translated by default
Make alt text for image translatable by default without settings of
gettext_additional_targets.
2020-07-19 12:58:28 +09:00
Takeshi KOMIYA
70d521ad9c Merge branch '3.x' 2020-07-11 21:59:58 +09:00
Takeshi KOMIYA
6dfbc5108e Close #7849: html: Add html_codeblock_linenos_style 2020-07-11 20:59:38 +09:00
Takeshi KOMIYA
d2fdc851fa doc: Add translation.png to build latexpdf successfully 2020-07-07 22:19:21 +09:00
Takeshi KOMIYA
1a223209f2 Merge branch '3.x' 2020-07-05 19:56:21 +09:00
Jakob Lykke Andersen
09e057edf2 Merge pull request #7906 from jakobandersen/noindexentry
Add :noindexentry: option
2020-07-05 09:25:18 +02:00
Jakob Lykke Andersen
c668500a4b Add :noindexentry: option
Fixes sphinx-doc/sphinx#7052
2020-07-04 19:34:00 +02:00
Takeshi KOMIYA
ec3754bd94 Merge branch '3.x' 2020-07-05 01:32:54 +09:00
Takeshi KOMIYA
44f4b2ad97 Merge tag 'v3.1.0' 2020-07-05 00:10:47 +09:00
Takeshi KOMIYA
0c24baaa0c doc: Update docs (refs: #7907) 2020-07-04 11:56:45 +09:00
Tim Metzler
5ba5cb60e3 Use double backticks for filename example 2020-07-03 19:08:53 +02:00
Tim Metzler
3982d526b2 Shorten line to less than 85 characters 2020-07-03 14:27:14 +02:00
Tim Metzler
9dcd88709c Clarify language specific figures format
I recently used sphinx for multilanguage documentation and found the explanation of the language specific figure format misleading. 
I replaced the underscores by periods and added a small example.
2020-07-03 14:11:53 +02:00
Jakob Lykke Andersen
8c82ecbf2c Merge pull request #7895 from jakobandersen/c_cpp_noindex
C, C++: remove noindex option
2020-07-02 15:38:45 +02:00
Jakob Lykke Andersen
ff5eb7cc2b C, C++: remove noindex option
The option did nothing.
Improve error messages on duplicates.
2020-06-30 13:52:18 +02:00
Jakob Lykke Andersen
7cbf54c210 C, add c:alias directive 2020-06-30 11:20:17 +02: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
068b9b5738 Merge branch '3.x' 2020-06-04 00:18:30 +09:00
Takeshi KOMIYA
a7725ad8ca Close #7247: linkcheck: Add linkcheck_request_headers 2020-06-01 01:48:46 +09:00
Takeshi KOMIYA
34f3579330 Merge pull request #7748 from tk0miya/2106_autodoc_docstring_signature_for_overloads
Close #2106: autodoc: Support multiple signatures on docstring
2020-05-31 14:48:41 +09:00
Takeshi KOMIYA
350f5b3600 Merge pull request #7751 from stephenfin/doc/intro-section
[doc] Remove the intro guide in favour of the quickstart guide
2020-05-31 01:12:35 +09:00
Stephen Finucane
97d1b323b7 docs: Merge intro and quickstart guide
The intro guide mostly contained out-of-date information or information
that was duplicated from elsewhere. Remove it in favour of an enhanced
quickstart guide.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-05-30 15:25:45 +01:00
Stephen Finucane
f07ad49c22 docs: Add usage, development index page
Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-05-30 15:24:40 +01:00
Stephen Finucane
ceb72f9cd7 doc: Rework "latex" document
Remove some unnecessary indentation, consistently document option
defaults, and fix some wrapping and whitespace.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-05-30 15:23:36 +01:00
Takeshi KOMIYA
800dcf0f0a Close #2106: autodoc: Support multiple signatures on docstring 2020-05-30 15:40:21 +09:00
Kai Welke
0ee57a6f6e Fixed broken link to pygments lexers doc 2020-05-26 09:35:47 +02:00
Michaël Defferrard
5e5bd748e6 remove repeted word in reStructuredText Primer 2020-05-20 22:30:58 +02: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
3c7d35d2a2 Merge branch '3.x' 2020-05-17 19:12:56 +09:00
Takeshi KOMIYA
b1554ae25a doc: Fix wrong version info 2020-05-10 01:12:39 +09:00
Takeshi KOMIYA
e5dad73cf2 py domain: Add :canonical: option 2020-05-04 14:49:50 +09:00
Takeshi KOMIYA
f82151bda5 Merge branch '3.x' 2020-05-02 10:43:10 +09:00
Takeshi KOMIYA
71eddf3095 Merge branch '3.x' 2020-04-30 21:49:28 +09: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
aa773cbc88 Merge branch '3.x' 2020-04-28 01:42:37 +09:00
Takeshi KOMIYA
87308d9607 Close #7143: py domain: Add :final: option to py:*: directives 2020-04-28 01:24:29 +09:00
Takeshi KOMIYA
42aa293679 Merge branch '3.x' 2020-04-27 00:54:23 +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
c2c95ef587 Merge pull request #7411 from tk0miya/latex_theme_options
LaTeX: Add `latex_theme_options` to override theme options
2020-04-20 01:50:06 +09:00