Commit Graph

16475 Commits

Author SHA1 Message Date
Takeshi KOMIYA
7c340e1c1c
Merge pull request #8691 from tk0miya/add_readthedocs.yml
Fix #8662: Add .readthedocs.yml
2021-01-16 21:42:18 +09:00
Takeshi KOMIYA
90ab89311f
Merge pull request #8667 from tk0miya/8652_invalid_type_comments
Fix #8652: autodoc: variable comments are ignored if invalid type comments found
2021-01-16 21:40:34 +09:00
Takeshi KOMIYA
8ce830e1cb Fix #8662: Add .readthedocs.yml 2021-01-16 21:31:50 +09:00
Takeshi KOMIYA
d635d94eeb
Merge pull request #8685 from tk0miya/8683_strftime_z
Fix #8683: html_last_updated_fmt does not support UTC offset (%z)
2021-01-14 01:11:24 +09:00
Takeshi KOMIYA
b742bde8e6
Merge pull request #8684 from tk0miya/2030_automatic_dedent
Fix #2030: automatic dedent support in code-block directive
2021-01-14 01:11:02 +09:00
Takeshi KOMIYA
f81310708b
Merge pull request #8678 from tk0miya/doc_html_baseurl
Fix #8677: doc: Update description of html_baseurl
2021-01-14 01:10:12 +09:00
Takeshi KOMIYA
fddc42847f Fix #2030: automatic dedent support in code-block directive 2021-01-13 01:10:28 +09:00
Takeshi KOMIYA
6101077aab
Merge pull request #8680 from tk0miya/deprecate_DocumenterBridge.reporter
refactor: Deprecate DocumenterBrdige.reporter
2021-01-13 01:08:45 +09:00
Takeshi KOMIYA
233e359330
Merge pull request #8679 from tk0miya/8651_xref_for_rubric
Fix #8651: cross-reference for a rubric having inline item is broken
2021-01-13 01:01:36 +09:00
Takeshi KOMIYA
8ff8b5532c Fix #8683: html_last_updated_fmt generates wrong time zone for %Z
sphinx.util.i18n:format_date() converts '%Z' to full name of time zone
unexpectedly.  It should be converted to short name.
2021-01-13 00:50:01 +09:00
Takeshi KOMIYA
d5559e1ba2 Fix #8683: html_last_updated_fmt does not support UTC offset (%z)
sphinx.util.i18n:format_date() does not support %z so far.  This
adds a mapping for %z to the babel form 'ZZZ'.
2021-01-13 00:49:59 +09:00
Jakob Lykke Andersen
e314789f4f
Merge pull request #8682 from jakobandersen/c_intersphinx_8341
C, C++, fix intersphinx and role lookup types
2021-01-11 21:22:04 +01:00
Jakob Lykke Andersen
88102c5188 Update CHANGES 2021-01-11 20:52:02 +01:00
Jakob Lykke Andersen
f7a1d66359 C++, fix object types for xrefs
Make them all work with intersphinx.
Strengthen templateParam a bit.
2021-01-11 20:51:36 +01:00
Jakob Lykke Andersen
750e6ec431 C, fix object types for xrefs
Add 'identifer' to all and 'type' to types.

Fixes sphinx-doc/sphinx#8341
2021-01-11 20:51:36 +01:00
Takeshi KOMIYA
dffb565eea refactor: Deprecate DocumenterBrdige.reporter
The logging system of Sphinx was migrated to sphinx.util.logging now.
So it's time to deprecate reporter interface for Documenters.
2021-01-12 01:48:16 +09:00
Takeshi KOMIYA
12ec8f0cae Fix #8651: cross-reference for a rubric having inline item is broken
The implementation of the standard domain so far has considered the
first child of the rubric node is the title of the rubric.  But it can
may multiple nodes when the rubric title is marked up.

This extracts the title of the rubric from the whole of the children
of it.
2021-01-11 22:50:45 +09:00
Takeshi KOMIYA
b372a99c01
Merge pull request #8674 from tk0miya/207_multiple_highlight_options
Close #207: Now highlight_language supports multiple languages
2021-01-11 21:49:29 +09:00
Takeshi KOMIYA
32ac5f2e57 Close #207: Now highlight_language supports multiple languages
This changes the structure of `highlight_options` to a dictionary that
maps language names to option dictionary.  It allows to setting pygments
options for multiple languages at once.
2021-01-11 21:40:09 +09:00
Takeshi KOMIYA
2444c4711e
Merge pull request #8675 from tk0miya/test_pydomain_abbr
test: Add testcase for relative/short xref for py domain
2021-01-11 21:32:03 +09:00
Takeshi KOMIYA
98993b40c5
Merge pull request #8672 from tk0miya/8671_highlight_options_not_working
Fix #8671: highlight_options is not working
2021-01-11 20:48:54 +09:00
Takeshi KOMIYA
d7cdb9e22d Fix #8671: highlight_options is not working
Sadly HTML and LaTeX writers compares the highlight languages using
`is` operator.  As a result, it has not worked even if languages are
same.  This replaces the comparison operator by `==`.
2021-01-11 20:37:05 +09:00
Takeshi KOMIYA
6e445e1175
Merge pull request #8673 from tk0miya/refactor_writers
refactor: Access config object from self directly in writers
2021-01-11 20:35:39 +09:00
Takeshi KOMIYA
5d07135a1e Fix #8677: doc: Update description of html_baseurl 2021-01-11 19:45:55 +09:00
Takeshi KOMIYA
a3df1d00c7 test: Add testcase for relative/short xref for py domain 2021-01-11 03:12:39 +09:00
Takeshi KOMIYA
410b8e03f3 refactor: Access config object from self directly in writers 2021-01-10 23:49:12 +09:00
Takeshi KOMIYA
b51c947c51
Merge pull request #8670 from tk0miya/fix_highlight_lang
doc: Fix highlight language
2021-01-10 22:35:00 +09:00
Takeshi KOMIYA
f433581b04 doc: Fix highlight language 2021-01-10 22:22:30 +09:00
Takeshi KOMIYA
eaa8612567 Fix #8652: autodoc: variable comments are ignored if invalid type comments found
To avoid the crash of ModuleAnalyzer from invalid type comments, this
start to retry parsing without type_comments=False when `ast.parse()`
raises SyntaxError.
2021-01-10 17:08:56 +09:00
Takeshi KOMIYA
7acafa991b Update CHANGES for PR #8665 2021-01-10 15:04:59 +09:00
Takeshi KOMIYA
ffba1d7068
Merge pull request #8665 from JeanKossaifi/3.x
Cast maxdepth to int in toctree
2021-01-10 15:03:03 +09:00
Jean Kossaifi
169c45bb35 Deal with empty string case. 2021-01-09 22:14:16 +00:00
Jean Kossaifi
f77461b4b7 Cast maxdepth to int in toctree
When specifying the max-depth for the toctree in theme.conf that isn't automatically cast to int, causing a hard to locate error.
2021-01-09 21:59:53 +00:00
Takeshi KOMIYA
d9569a84a2 Merge branch '3.4.x' into 3.x 2021-01-08 01:18:53 +09:00
Takeshi KOMIYA
458ccbea0b Bump version 2021-01-08 01:17:58 +09:00
Takeshi KOMIYA
55cdadf973 Bump to 3.4.3 final 2021-01-08 01:16:15 +09:00
Takeshi KOMIYA
ca9342cc44
Merge pull request #8631 from tk0miya/6241_assets_for_specific_page
Close #6241: html: Allow to add JS/CSS files to the specific page
2021-01-08 01:11:17 +09:00
Takeshi KOMIYA
ac12d8dabe
Merge pull request #8656 from tk0miya/8655_exception_on_hasattr
Fix #8655: autodoc: Crashes when object raises an exception on hasattr()
2021-01-07 02:12:27 +09:00
Takeshi KOMIYA
af4e615a8a Close #6241: html: Allow to add JS/CSS files to the specific page
Allow to add JS/CSS files to the specific page when an extension calls
`app.add_js_file()` or `app.add_css_file()` on `html-page-context`
event.
2021-01-07 02:12:07 +09:00
Takeshi KOMIYA
a51c8a5652 Fix #8655: autodoc: Crashes when object raises an exception on hasattr()
autodoc crashes when the target object raises an exception on
`hasattr()`.  The `hasattr()` function internally calls the
`obj.__getattr__()` or `obj.__getattribute__()` of the target object.
Hence the reaction can be changed on the target object.

This starts to use `safe_getattr()` to check the object is mocked or not
and to prevent an unexpected error.
2021-01-05 23:37:40 +09:00
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