Commit Graph

16435 Commits

Author SHA1 Message Date
Takeshi KOMIYA
ac7d574fce refactor: mathjax: Add a constant for the URL of mathjax 2021-01-04 22:22:08 +09:00
Takeshi KOMIYA
2d53b7cd66 Update CHANGES for PR #8649 2021-01-04 22:18:28 +09:00
Takeshi KOMIYA
41e6f152eb
Merge pull request #8649 from sephalon/imgconverter-availability
Skip imgconverter availability check if builder supports the image type
2021-01-04 22:17:37 +09:00
Takeshi KOMIYA
8131e03a52 Merge branch '3.4.x' into 3.x 2021-01-04 21:46:40 +09:00
Takeshi KOMIYA
4755557a7d Bump version 2021-01-04 21:43:54 +09:00
Takeshi KOMIYA
83d5a323ef Bump to 3.4.2 final 2021-01-04 21:42:37 +09:00
Takeshi KOMIYA
1429e6f92e
Merge pull request #8646 from tk0miya/refactor_typehints
refactor: Update typehints for ObjectDescription using Generic
2021-01-04 21:37:02 +09:00
Takeshi KOMIYA
1361126aa2
Merge pull request #8641 from tk0miya/8639_update_docs
doc: Add explanation for the priority attribute of html_*_files
2021-01-04 21:32:44 +09:00
Takeshi KOMIYA
b59a48d413
Merge pull request #8650 from tk0miya/update_release_checklist
doc: Quote URLs in release checklist
2021-01-04 21:24:48 +09:00
Takeshi KOMIYA
b3f8bd1e3c doc: Quote URLs in release checklist
To improve the install process, the commands on the checklist is updated
to allow to copy & paste it to console.
2021-01-04 21:12:27 +09:00
Stefan Wiehler
ef23669653 Skip imgconverter availability check if builder supports the image type
Close #7973: ImgConverter runs is_available in HTML builder
Close missinglinkelectronics/sphinxcontrib-svg2pdfconverter#8: Extension should only run on LaTeX builder
2021-01-04 10:32:46 +01:00
Takeshi KOMIYA
bad2444ed5 refactor: Update typehints for ObjectDescription using Generic 2021-01-03 22:50:38 +09:00
Takeshi KOMIYA
7739b7d7dd doc: Add explanation about stable sort of html_*_files 2021-01-03 00:17:19 +09:00
Takeshi KOMIYA
e9a4ebf70d doc: Add explanation for the priority attribute of html_*_files 2021-01-03 00:16:10 +09:00
Takeshi KOMIYA
1b7d16505e
Merge pull request #8639 from tk0miya/8634_css_priority
Close #8634: html: Allow to change the order of JS/CSS
2021-01-02 23:34:18 +09:00
Takeshi KOMIYA
99c580d563
Merge pull request #8640 from xuhdev/recursive
DOC: `modules` are only available when `recursive` is on
2021-01-02 12:12:33 +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
c5f0398010 Close #8634: html: Allow to change the order of JS/CSS
`Sphinx.add_js_file()` and `Sphinx.add_css_file()` take `priority`
argument to change the order of JS/CSS files.
2021-01-02 02:06:34 +09:00
Takeshi KOMIYA
7ecf6b88aa Merge branch '3.4.x' into 3.x 2021-01-01 13:56:19 +09:00
Takeshi KOMIYA
1346ddf317
Merge pull request #8635 from tk0miya/update_copyright
A happy new year! (Updating copyright)
2021-01-01 13:51:51 +09:00
Takeshi KOMIYA
f996859420 A happy new year!
.. note::

   $ find sphinx tests LICENSE doc/conf.py -type f -exec sed -i '' -e 's/2007\-20../2007-2021/' {} \;
   $ git co sphinx/locale/**/*.js sphinx/templates/epub3/mimetype
2021-01-01 13:40:48 +09:00
Takeshi KOMIYA
54ef601049
Merge pull request #8630 from tk0miya/8629_warning_for_html_use_opensearch_twice
Fix #8629: html: A type warning for html_use_opensearch is shown twice
2021-01-01 13:14:39 +09:00
Takeshi KOMIYA
b2c9297bd2
Merge pull request #8627 from tk0miya/8315_struct.Struct
Fix #8315: autodoc: Failed to resolve struct.Struct type annotation
2021-01-01 13:13:11 +09:00
Takeshi KOMIYA
663074e3ce
Merge pull request #8626 from tk0miya/refactor_test_autosummary
refactor: test: Use rollback_sysmodules fixture in test_ext_autosummary
2021-01-01 13:12:35 +09:00
Takeshi KOMIYA
05b67f2a3e
Merge pull request #8633 from tk0miya/merge_3.4.x
Merge 3.4.x to 3.x
2021-01-01 13:11:56 +09:00
Takeshi KOMIYA
d82a3c2047
Merge pull request #8625 from tk0miya/refactor_autodoc3
refactor: autodoc: Allow None value from get_doc()
2021-01-01 13:08:36 +09:00
Takeshi KOMIYA
63e0127b38 refactor autodoc to adjust new AttributeDocumenter 2020-12-31 21:37:35 +09:00
Takeshi KOMIYA
9ec65ff039 Merge branch '3.4.x' into merge_3.4.x 2020-12-31 21:33:43 +09:00
Takeshi KOMIYA
0f1fcdc113
Merge pull request #8632 from tk0miya/fix_test_markup
Fix test: missing compound class for kbd tag
2020-12-31 21:30:56 +09:00
Takeshi KOMIYA
5383846ced
Merge pull request #8622 from tk0miya/8616_AttributeError_for_non_class
Fix #8616: autodoc: AttributeError when non-class is passed to autoclass
2020-12-31 21:22:06 +09:00
Takeshi KOMIYA
2eb8927b89 Fix test: missing compound class for kbd tag 2020-12-31 21:20:38 +09:00
Takeshi KOMIYA
1353a7b82f
Merge branch '3.4.x' into 8616_AttributeError_for_non_class 2020-12-31 21:12:29 +09:00
Takeshi KOMIYA
b31b8df9bf
Merge pull request #8620 from tk0miya/8619_compound_kbd
Close #8619: html: kbd role generates customizable HTML tags for compound keys
2020-12-31 21:11:42 +09:00
Takeshi KOMIYA
60557715d2 Fix #8629: html: A type warning for html_use_opensearch is shown twice 2020-12-31 18:45:00 +09:00
Takeshi KOMIYA
f1a051fdfc Fix #8315: autodoc: Failed to resolve struct.Struct type annotation
The builtin module, ``struct.Struct`` does not have correct module
name since Python 3.8.  This allows to refer it automatically.
2020-12-31 14:25:05 +09:00
Takeshi KOMIYA
332d80ba84
Merge pull request #8621 from tk0miya/8618_kbd_for_single_separator
Fix #8618: html: incorrect HTML for single compound-kdb separators
2020-12-31 10:57:40 +09:00
Takeshi KOMIYA
54e8b8d9bc refactor: test: Use rollback_sysmodules fixture in test_ext_autosummary 2020-12-31 10:55:45 +09:00
Takeshi KOMIYA
2e0ea32111 refactor: autodoc: Allow None value from get_doc()
Now Documenter.get_doc() can reeturn None if it can't have any docstring.
So its caller should handle None value.
2020-12-31 10:51:53 +09:00
Takeshi KOMIYA
a1d501d876
Merge pull request #8615 from tk0miya/refactor_autodoc
refactor: autodoc: Replace ClassAttribute by ObjectMember
2020-12-31 10:44:09 +09:00
Takeshi KOMIYA
1dd0cc8494
Merge pull request #8611 from tk0miya/8602_process-docstring_for_nondatadescriptors
Fix #8602: autodoc: The ``autodoc-process-docstring`` event is emitted to the non-datadescriptors unexpectedly
2020-12-31 10:43:20 +09:00
Takeshi KOMIYA
e3b1fdeeeb
Merge branch '3.4.x' into 8602_process-docstring_for_nondatadescriptors 2020-12-31 10:13:03 +09:00
Takeshi KOMIYA
0f8debe558 Fix #8616: autodoc: AttributeError when non-class is passed to autoclass
Since 3.4.0, AttributeError is raised when non-class object is passed to
the autoclass directive.  It has built successfully before 3.4.0
release.  So this handles the exception on generating "alias" text.
2020-12-30 23:29:06 +09:00
Takeshi KOMIYA
6a53c53d53 Fix #8618: html: incorrect HTML for single compound-kdb separators 2020-12-30 21:12:00 +09:00
Takeshi KOMIYA
8e5f4e5616 Close #8619: html: kbd role generates customizable HTML tags for compound keys 2020-12-30 20:36:09 +09:00
Takeshi KOMIYA
21698c1446
Merge pull request #8614 from tk0miya/deprecate_AttributeDocumenter_isinstanceattribute
refactor: Deprecate AttributeDocumenter.isinstanceattribute()
2020-12-30 19:47:17 +09:00
Takeshi KOMIYA
839d2594a2 refactor: autodoc: Replace ClassAttribute by ObjectMember
After the series of refactoring, it would be better to use ObjectMember
directly inside get_class_members(). And ClassAttribute is no longer
needed.
2020-12-30 12:17:05 +09:00
Takeshi KOMIYA
c99412695d
Merge pull request #8292 from tk0miya/update_coding_style
docs: Update coding style
2020-12-30 01:44:03 +09:00
Takeshi KOMIYA
c0f923ee6c refactor: Deprecate AttributeDocumenter.isinstanceattribute() 2020-12-29 20:06:29 +09:00
Takeshi KOMIYA
ae9768385a Merge branch '3.4.x' into 3.x 2020-12-29 19:40:40 +09:00
Takeshi KOMIYA
3f560cd672
Merge pull request #8612 from tk0miya/reduce_Warning
refactor: Reduce warnings on testing
2020-12-29 19:39:41 +09:00