Commit Graph

16796 Commits

Author SHA1 Message Date
Takeshi KOMIYA
0ad32905bf Merge branch '3.x' 2021-01-24 16:39:43 +09:00
Takeshi KOMIYA
51d500833e Merge branch '3.x' into 7774_remove_develop.rst 2021-01-24 16:34:47 +09:00
Takeshi KOMIYA
41ee2d6e65 Merge pull request #8738 from tk0miya/8118_today_fmt
Fix #8118: doc: the default setting of today_fmt
2021-01-24 14:42:20 +09:00
Takeshi KOMIYA
0e6a2a9ebd Merge pull request #8737 from tk0miya/8510_html_logo_url
Allow user to use url to reference html logo & favicon
2021-01-24 14:40:56 +09:00
Takeshi KOMIYA
851716cd1a Merge pull request #8744 from tk0miya/refactor_doc4
doc: Apply :params: to some APIs in app class
2021-01-24 14:39:21 +09:00
Takeshi KOMIYA
502c4ee5fb Merge branch '3.x' 2021-01-24 14:32:13 +09:00
Takeshi KOMIYA
becf8f43be Merge pull request #8599 from tk0miya/6550_html_permalinks_icon
Close #6550: html: Allow to use HTML permalink texts
2021-01-24 14:30:06 +09:00
Takeshi KOMIYA
15cbc6dbb0 Close #6550: html: Allow to use HTML permalink texts
Add new configuration variables: `html_permalinks` and
`html_permalinks_icon`.

This refines the settings around HTML permalinks.

* html_add_permalinks
  * Deprecated.
* html_permalinks
  * Enable or disable permalinks feature.
* html_permalinks_icon
  * Change the icon for permalinks
2021-01-24 14:17:07 +09:00
Takeshi KOMIYA
59036b1e65 Update sphinx/application.py 2021-01-24 14:16:26 +09:00
Takeshi KOMIYA
3a0a6556c5 Merge pull request #8741 from tk0miya/refactor_doc3
doc: Show type annotations for methods of Sphinx application class
2021-01-24 14:11:37 +09:00
Takeshi KOMIYA
93c3edca2f Merge pull request #8743 from tk0miya/8054_types_for_add_config_value
Fix #8054: Add explanation for types argument of add_config_value()
2021-01-24 14:09:26 +09:00
Takeshi KOMIYA
790adf1f4a Merge pull request #8739 from tk0miya/refactor_doc2
doc: minor fix
2021-01-24 14:08:39 +09:00
Takeshi KOMIYA
97f54bdf31 Merge pull request #8733 from tk0miya/update_underscore.js-1.12.0
Update Underscore.js to 1.12.0
2021-01-24 14:07:16 +09:00
Takeshi KOMIYA
ee5560b773 Merge pull request #8732 from tk0miya/refactor_documentation_options
refactor: html theme: Insert documentation_options.js via script_files
2021-01-24 14:00:13 +09:00
Takeshi KOMIYA
deda1918fc Merge pull request #8731 from tk0miya/8004_preprocess_types_for_google
Fix #8004: napoleon_preprocess_types for Google style docstrings
2021-01-24 13:59:21 +09:00
Takeshi KOMIYA
2522b61185 Merge pull request #8729 from tk0miya/8727_namespace_subpackage
Fix #8727: apidoc: namespace module file is not generated if no submodules
2021-01-24 13:58:33 +09:00
Takeshi KOMIYA
a2d6ee6108 doc: Apply :params: to some APIs in app class 2021-01-24 01:11:04 +09:00
Takeshi KOMIYA
f873a5890f Fix #8054: Add explanation for types argument of add_config_value() 2021-01-24 00:44:20 +09:00
Takeshi KOMIYA
2626a74f0a doc: Show type annotations for methods of Sphinx application class 2021-01-24 00:08:04 +09:00
Takeshi KOMIYA
3100ceb220 doc: minor fix 2021-01-23 22:32:17 +09:00
Takeshi KOMIYA
f707cb30a1 Merge pull request #7798 from stefanodavid/code-block-crossref-doc
documentation for proper code-block cross-referencing
2021-01-23 22:31:02 +09:00
Takeshi KOMIYA
41924776c4 Fix #8118: doc: the default setting of today_fmt
Sphinx has used `'%b %d, %Y'` as a default setting of today_fmt longer.
So this fixes our document as Sphinx does.
2021-01-23 22:11:33 +09:00
Takeshi KOMIYA
2843fdfdea Merge pull request #8736 from jfbu/latex_fix_8735
Fix #8735
2021-01-23 21:01:44 +09:00
Takeshi KOMIYA
c50ce99c9d refactor: Remove unused method 2021-01-23 20:51:02 +09:00
Takeshi KOMIYA
9d975b65bd Update CHANGES for PR #8510 2021-01-23 20:50:21 +09:00
Takeshi KOMIYA
7cfcd81b76 doc: html_favicon and html_logo accept URL now 2021-01-23 20:49:15 +09:00
Takeshi KOMIYA
76d0a0be82 Update CHANGES 2021-01-23 20:45:03 +09:00
Takeshi KOMIYA
ccf4ae3729 Merge branch 'master' into 8510_html_logo_url 2021-01-23 20:44:13 +09:00
Takeshi KOMIYA
65a69965a1 html theme: Add favicon_url and logo_url
To embed the external favicon and logo image, this adds new template
variable `favicon_url` and `logo_url` that point the external URL or
relative path for the favicon/logo file from current file.  It helps to
use it on template files.
2021-01-23 20:39:09 +09:00
jfbu
e63365f94e Fix #8735
It is hard to provide a unit test, because the problem only raises a
LaTeX warning and shows as broken internal links in pdf output.

As the fix moves some LaTeX code to the end of preamble, user or
extension code may have to be moved there too.  However, a large part of
it already was delayed.  I checked that sphinxmessages.tex does not
introduce preamble code which would be broken from missing macros due
to this change.
2021-01-23 11:21:29 +01:00
Takeshi KOMIYA
3f5fc6278c refactor: Add sphinx.util:isurl() 2021-01-23 18:39:27 +09:00
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
37fc43a4d3 Merge pull request #8734 from stevepiercy/patch-2
Update the link to the new sphinx-contrib organization
2021-01-23 17:27:04 +09:00
Jean-François B
38c6143470 Merge pull request #8716 from jfbu/latex_font_for_pdflatex
LaTeX: update default font configuration
2021-01-23 09:22:18 +01:00
jfbu
2e22bd0a23 Merge branch 'master' into latex_font_for_pdflatex 2021-01-23 09:13:08 +01:00
Takeshi KOMIYA
85e49ab20f Update CHANGES for PR #8247 2021-01-23 17:10:12 +09:00
Takeshi KOMIYA
87e28af9e5 Merge pull request #8648 from tk0miya/refactor_abc
refactor: some domain base classes become subclasses of abc.ABC
2021-01-23 17:09:17 +09:00
Steve Piercy
bd63ae9950 Update the link to the new sphinx-contrib organization
This should be backported to at least 3.x, too.
2021-01-23 00:08:57 -08:00
Takeshi KOMIYA
af0dfa20d0 Merge pull request #8247 from silene/inter_prodlist_refs
Allow production lists to refer to tokens from other production groups.
2021-01-23 17:07:52 +09:00
Takeshi KOMIYA
05eb3c6054 refactor: Index class becomes subclasses of abc.ABC
The `Index` class becomes subclasses of `abc.ABC` to indicate
methods that must be overrided in the concrete classes.
2021-01-23 16:59:55 +09:00
Guillaume Melquiond
ffacb2ca18 Add testcase. 2021-01-23 08:57:36 +01:00
Takeshi KOMIYA
9a905ce547 Merge pull request #8724 from jfbu/latex_fancyboxissue
Closes: #8339
2021-01-23 16:47:21 +09:00
Takeshi KOMIYA
1b4265da4d Update Underscore.js to 1.12.0 2021-01-23 16:41:59 +09:00
Takeshi KOMIYA
a957d6f710 refactor: html theme: Insert documentation_options.js via script_files 2021-01-23 15:39:37 +09:00
Takeshi KOMIYA
440e64a91b Fix #8004: napoleon_preprocess_types for Google style docstrings
Type definitions in Google style docstrings are rendered as references
when :confval:`napoleon_preprocess_types` enabled.
2021-01-23 14:20:19 +09:00
jfbu
524473372a Remove unneeded CHANGES entry mentioning #8339 2021-01-22 20:34:53 +01:00
Takeshi KOMIYA
650f8ea237 Fix #8727: apidoc: namespace module file is not generated if no submodules
sphinx-apidoc should generate a namespace module file when
`--implicit-namespace` option given.  This fixes the case the namespace
module has subpackages, but no submodules.
2021-01-23 00:40:16 +09:00
Takeshi KOMIYA
5ce72f465b Merge branch '3.x' 2021-01-22 22:52:32 +09:00
Takeshi KOMIYA
a71028bf9e Merge pull request #8719 from tk0miya/8714_kbd_capslock
Fix #8714: html: kbd role with "Caps Lock" rendered incorrectly
2021-01-22 22:07:06 +09:00
Takeshi KOMIYA
4dd4ff8736 Merge pull request #8726 from markus-oehme-pg40/patch-1
doc: Link to detailed extension documentation
2021-01-22 22:02:13 +09:00