Commit Graph

19362 Commits

Author SHA1 Message Date
Takeshi KOMIYA
06a9139308 Fix #9648: autodoc: *args and **kwargs entries are duplicated
In basic usage of autodoc (docstring), `args` and `kwargs` arguments
are marked up without stars.  But numpydoc style recommends to mark
them up with stars.

This adds support for starred arguments in docstrings to
`autodoc_typehints` feature.
2022-05-15 23:06:49 +09:00
Takeshi KOMIYA
d8a540e922 Fix #9575: autodoc: Return annotation should not be shown 2022-05-15 20:51:42 +09:00
Takeshi KOMIYA
92fcac321b test: Add *args and **kwargs to testcase of target.typehints 2022-05-15 19:05:17 +09:00
Takeshi KOMIYA
36367765fe
Merge pull request #10450 from sphinx-doc/bot/pull-translations
Update message catalogs
2022-05-15 12:13:04 +09:00
tk0miya
51fc4d180b Update message catalogs 2022-05-15 00:25:13 +00:00
Aaron Carlisle
b0ae5480c5
Epub: Add WebP mime type
When building docs with WebP images using the EPUB builder results in this warning:

`WARNING: unknown mimetype for _images/<image_name>.webp, ignoring`

This commit fixes this by adding the mapping for webp-files to the correct mime type.
2022-05-10 17:35:00 -04:00
Takeshi KOMIYA
1222bed88e Bump version 2022-05-09 00:57:07 +09:00
Takeshi KOMIYA
23ab36bcd7 Bump version 2022-05-09 00:55:57 +09:00
Takeshi KOMIYA
ea3468d597 Bump to 5.0.0 beta1 2022-05-09 00:54:24 +09:00
Takeshi KOMIYA
e770e2567f
Merge pull request #10427 from tk0miya/10421_autodoc_preserve_defaults_for_classmethod
Fix #10421: autodoc_preserve_defaults doesn't work on class methods
2022-05-08 23:19:10 +09:00
Takeshi KOMIYA
10dd5a0e43 Fix #10421: autodoc_preserve_defaults doesn't work on class methods 2022-05-08 22:59:14 +09:00
Takeshi KOMIYA
f58771c093
Merge pull request #10429 from tk0miya/9974_jquery-3.6.0
Close #9974: html: Updated jQuery version from 3.5.1 to 3.6.0
2022-05-08 19:04:49 +09:00
Takeshi KOMIYA
fa35e71894
Merge pull request #10430 from tk0miya/remove_test_for_jsdump
test: Remove tests for jsdump module (deprecated)
2022-05-08 19:04:17 +09:00
Takeshi KOMIYA
4eb236799b
Merge pull request #10431 from tk0miya/10337_refactor_Builder.read_doc
refactor: Create a copy of settings on Builder.write_doctree()
2022-05-08 19:04:00 +09:00
Takeshi KOMIYA
876de9cd8b
Merge pull request #10432 from sphinx-doc/bot/pull-translations
Update message catalogs
2022-05-08 19:03:06 +09:00
Takeshi KOMIYA
4b28bdd83b
Merge pull request #10435 from jfbu/10434_latex_inlinecode
Fix #10434: extra whitespace in pdf output for highlighted inline code
2022-05-08 19:02:05 +09:00
jfbu
97f4a036d1 Fix #10434: extra whitespace in pdf output for highlighted inline code
Related: #10251
2022-05-08 11:32:37 +02:00
Jean-François B
f1061c012e
Merge pull request #10365 from LuisBL/10363-sphinxmaketitle-should-use-linewidth-fix
fix #10363 make sphinxmaketitle ruler use \linewidth not \textwidth
2022-05-08 10:29:03 +02:00
Luis
6487529cf5 Fix #10363: make howto LaTeX title page rule use \linewidth 2022-05-08 10:20:51 +02:00
tk0miya
271c8d7bd3 Update message catalogs 2022-05-08 00:18:17 +00:00
Takeshi KOMIYA
27a62bbe39
Merge pull request #10197 from palewire/patch-1
Reduce `body_min_width` in basic theme
2022-05-08 02:47:00 +09:00
Takeshi KOMIYA
d7af818ba3 Update CHANGES for PR #10197 2022-05-08 02:38:56 +09:00
Takeshi KOMIYA
eee6be61ab html theme: Change the default body_min_width to 360px
Some reports says 360px is smallest size at present.

refs:

- https://www.browserstack.com/guide/ideal-screen-sizes-for-responsive-design
- https://mediag.com/blog/popular-screen-resolutions-designing-for-all/
2022-05-08 02:37:34 +09:00
Takeshi KOMIYA
a48e811781 Merge branch '5.x' into patch-1 2022-05-08 02:36:54 +09:00
Takeshi KOMIYA
294da2aa09 refactor: Create a copy of settings on Builder.write_doctree() 2022-05-08 02:30:23 +09:00
Takeshi KOMIYA
58c5424bb4 Update CHANGES for PR #10337 2022-05-08 02:25:54 +09:00
Takeshi KOMIYA
431caac943
Merge pull request #10337 from AA-Turner/reuse-publisher
Cache `Publisher` objects to speed up Sphinx
2022-05-08 02:24:27 +09:00
Takeshi KOMIYA
f9dce5764e Mark sphinx.io:read_doc() deprecated 2022-05-08 02:15:58 +09:00
Takeshi KOMIYA
39ce0182ff Merge branch '5.x' into reuse-publisher 2022-05-08 02:13:42 +09:00
Takeshi KOMIYA
19c347e790
Merge pull request #10147 from zuqq/4.x
Apply `autodoc_typehints_format` to all type hints
2022-05-08 00:59:55 +09:00
Takeshi KOMIYA
8db3724e6d test: Remove tests for jsdump module (deprecated) 2022-05-08 00:48:18 +09:00
Takeshi KOMIYA
d5e76d69e8 test: Prepend "~typing" to the result of autodata
The default setting has been changed since 5.0.
2022-05-08 00:44:28 +09:00
Takeshi KOMIYA
7134317e49 Merge remote-tracking branch 'origin/5.x' into HEAD 2022-05-07 22:37:58 +09:00
Takeshi KOMIYA
ba0d5a2666
Merge pull request #10428 from tk0miya/10258_autosummary
Recognize a documented attribute of a module as non-imported
2022-05-07 22:29:34 +09:00
Takeshi KOMIYA
06e5c036b7 Fix an isort warning 2022-05-07 22:20:43 +09:00
Takeshi KOMIYA
541fcfc557 Close #9974: html: Updated jQuery version from 3.5.1 to 3.6.0 2022-05-07 22:18:00 +09:00
Takeshi KOMIYA
5707e63903 Update CHANGES for PR #10258 2022-05-07 22:09:25 +09:00
Takeshi KOMIYA
d7c1f6ed68 autosummary: global variables having doc-comment are considered as non-imported members of the module 2022-05-07 22:07:45 +09:00
Takeshi KOMIYA
ae96a3ea85 Fix a flake8 warning 2022-05-07 21:28:05 +09:00
Takeshi KOMIYA
5344b1b241 Merge branch '5.x' into 10258_autosummary 2022-05-07 21:27:47 +09:00
Adam Turner
919eb1db91 Inline io.read_doc and explain why settings are copied 2022-05-07 13:11:39 +01:00
Takeshi KOMIYA
3bc1a33892
Merge pull request #10426 from tk0miya/fix_typo
Fix typo
2022-05-07 20:03:29 +09:00
Takeshi KOMIYA
4278a8a51b Fix typo 2022-05-07 16:13:26 +09:00
Takeshi KOMIYA
425a3e6c09 Merge branch '4.x' into 5.x 2022-05-06 03:32:43 +09:00
Takeshi KOMIYA
efd4712dc8 Update CHANGES for PR #10251 2022-05-06 02:59:01 +09:00
Takeshi KOMIYA
3805e0646f
Merge pull request #10251 from jbms/fix-inline-syntax-highlight
Make code role highlighting consistent with code-block directive
2022-05-06 02:54:42 +09:00
Takeshi KOMIYA
21fb2caad6
Merge pull request #10412 from tk0miya/deprecate_sphinx.util.docutils.__version_info__
Remove sphinx.util.docutils.__version_info__ on 7.0
2022-05-05 19:46:58 +09:00
Takeshi KOMIYA
335bf513e8
Merge pull request #10413 from AA-Turner/fix-split-coverage
CI: fix coverage job
2022-05-03 02:32:15 +09:00
Adam Turner
00324a566b CI: fix coverage job 2022-05-02 18:23:12 +01:00
Takeshi KOMIYA
e4f78df2fc
Merge pull request #10345 from Thecarisma/fix-theming-add-static-file-documentation
Refractor the example in 'Add your own static files to the build assets' documentation section
2022-05-03 02:10:57 +09:00