Martin Liska
9ec829fb50
texinfo: simplify reference emission.
...
The commit adds a new config value 'texinfo_emit_document_references'
that blocks the emission of inline references and make it better readable
with legacy stand-alone reader ``info``.
Before the change we emit:
Default option value for @ref{e,,-Wshift-overflow3}.
while with texinfo_emit_document_references == True:
Default option value for -Wshift-overflow3.
It addresses limitations mentioned in Sphinx' FAQ:
https://www.sphinx-doc.org/en/master/faq.html#texinfo-info
2021-11-12 14:00:48 +01:00
Oleg Hoefling
7b318d8acb
apply review suggestions
...
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
2021-11-12 09:56:16 +01:00
oleg.hoefling
bc5dd0e6f3
add changelog entry
...
Signed-off-by: oleg.hoefling <oleg.hoefling@gmail.com>
2021-11-12 09:41:52 +01:00
oleg.hoefling
629145a0e8
replace hardcoded refs in docs with extlinks
...
Signed-off-by: oleg.hoefling <oleg.hoefling@gmail.com>
2021-11-12 09:41:34 +01:00
oleg.hoefling
8356260554
extlinks: replacement suggestions for hardcoded links
...
Signed-off-by: oleg.hoefling <oleg.hoefling@gmail.com>
2021-11-12 09:38:59 +01:00
Hugo van Kemenade
f8815ebfb0
Create GitHub release from tag
2021-11-12 10:30:29 +02:00
Takeshi KOMIYA
cee86909b9
Update CHANGES for PR #9815
2021-11-12 01:51:12 +09:00
Takeshi KOMIYA
921cbe12d0
Merge pull request #9815 from not-my-profile/sidebar-divs
...
base theme: Wrap sidebar components in <div>s
2021-11-12 01:49:28 +09:00
Takeshi KOMIYA
b0e119cd72
Close #9807 : Restrict docutils to 0.17.x or older
2021-11-12 01:21:20 +09:00
Takeshi KOMIYA
f34a0dddff
Bump version
2021-11-12 01:20:48 +09:00
Takeshi KOMIYA
ea38d96298
Fix #9838 : autodoc: AttributeError is raised for lru_cache
2021-11-12 00:46:58 +09:00
Takeshi KOMIYA
121d9394fc
Bump version
2021-11-11 02:25:06 +09:00
Takeshi KOMIYA
8e0c7a75f8
Bump version
2021-11-11 02:24:22 +09:00
Takeshi KOMIYA
3001cc9f8d
Bump to 4.3.0 final
2021-11-11 02:22:40 +09:00
Takeshi KOMIYA
d321a971d1
Merge pull request #9837 from tk0miya/9833_RemovedInSphinx60Warning
...
Fix the type of deprecation warning for get_signature_prefix (refs: #9833 )
2021-11-11 02:15:56 +09:00
Takeshi KOMIYA
5339636084
Fix the type of deprecation warning for get_signature_prefix (refs: #9833 )
2021-11-11 02:07:48 +09:00
Takeshi KOMIYA
5999cdb10d
Merge pull request #9833 from jakobandersen/py_get_signature_prefix
...
Make fallback for changed get_signature_prefix()
2021-11-11 02:05:37 +09:00
Jakob Lykke Andersen
63bd4b8062
Use warnings.warn and deprecation warning
2021-11-09 20:37:34 +01:00
Takeshi KOMIYA
096e28693e
Merge pull request #9628 from tk0miya/9623_suppress_warnings_for_excluded_document_in_toctree
...
Close #9623 : Allow to suppress warnings on excluded document found in toctree
2021-11-10 02:17:04 +09:00
Takeshi KOMIYA
1317eeedae
Merge pull request #9828 from tk0miya/9618_gettext_allow_fuzzy_translations
...
Close #9618 : i18n: Add gettext_allow_fuzzy_translations
2021-11-10 01:45:07 +09:00
Takeshi KOMIYA
7357b17e09
Merge branch '4.x' into 9623_suppress_warnings_for_excluded_document_in_toctree
2021-11-10 01:44:28 +09:00
Takeshi KOMIYA
22bec4ffe4
Fix #9623 : Separate warning type 'toc.not_readable' to 'toc.excluded'
2021-11-10 01:43:59 +09:00
Takeshi KOMIYA
563936b969
Merge pull request #9829 from tk0miya/9450_load_mathjax_as_defer
...
Close #9450 : mathjax: Load MathJax via "defer" strategy
2021-11-10 01:32:43 +09:00
Takeshi KOMIYA
203094b4c3
Close #9618 : i18n: Add gettext_allow_fuzzy_translations
2021-11-10 01:32:02 +09:00
Jakob Lykke Andersen
d20cb96773
Fix lint errors
2021-11-09 09:31:56 +01:00
Jakob Lykke Andersen
3599f7d844
Make fallback for changed get_signature_prefix()
...
Fixes sphinx-doc/sphinx#9832
2021-11-09 09:18:50 +01:00
Takeshi KOMIYA
4cd19b8274
Close #9450 : mathjax: Load MathJax via "defer" strategy
...
To allow configure MathJax via static JS file, it should be loaded via
"defer" strategy.
2021-11-09 01:54:56 +09:00
Takeshi KOMIYA
6c6cc8a6f5
Merge pull request #9826 from tk0miya/9820_reduce_distutils_usage
...
Replace distutils.versions.LooseVersion by packaging.version.Version
2021-11-09 00:42:03 +09:00
Martin Liska
faed8cb8db
texinfo: improve variable in :samp: directives
...
The following snippet:
Show :samp:`Samp with a {variable}.`
Ends in .info as:
Show ‘Samp with a `variable'.’
Which is suboptimal and @var{variable} should be rather used.
That results in ‘Samp with a VARIABLE.’.
2021-11-08 11:30:44 +01:00
Takeshi KOMIYA
ee1cae8c1c
Replace distutils.versions.LooseVersion by packaging.version.Version
...
Distutils module are now deprecated and will be removed in Python 3.12.
This replaces it by packaging module and reduces the dependency to it.
refs: #9820
2021-11-07 20:15:07 +09:00
Takeshi KOMIYA
8e350495b0
Merge pull request #9812 from not-my-profile/doc-theme-responsiveness
...
Document responsiveness of themes
2021-11-07 19:17:05 +09:00
Takeshi KOMIYA
ab54ce2579
Merge pull request #9821 from hugovk/rm-py-workaround
...
CI: Remove py workaround
2021-11-07 18:58:29 +09:00
Takeshi KOMIYA
2c22f1c3d6
Merge pull request #9823 from sphinx-doc/bot/pull-translations
...
Update message catalogs
2021-11-07 18:14:20 +09:00
tk0miya
f31ca06e3a
Update message catalogs
2021-11-07 00:10:53 +00:00
Hugo van Kemenade
2d9c6db3ce
Remove py workaround
2021-11-05 13:14:42 +02:00
Martin Fischer
9e7e6dd5ed
base theme: Wrap sidebar components in <div>s
...
Responsive themes inheriting from the base theme might want to display
the sidebar horizontally on narrower screens, which can be easily
achieved with flexbox. This however requires that the individual sidebar
components are wrapped in HTML elements so that flexbox can properly lay
them out.
2021-11-03 12:22:23 +01:00
Martin Fischer
43be17acf1
Document responsiveness of themes
2021-11-03 10:53:38 +01:00
Takeshi KOMIYA
1f91a0f8bd
Merge pull request #9799 from tk0miya/9781_autodoc_preserve_hexadecimal
...
Fix #9781 : autodoc_preserve_defaults does not support hexadecimal
2021-11-01 00:58:33 +09:00
Jakob Lykke Andersen
a8eb1aab72
Merge pull request #9459 from jakobandersen/intersphinx_refac_disable
...
Intersphinx, refactoring and intersphinx_disable_domains
2021-10-31 14:42:12 +01:00
Jakob Lykke Andersen
56002be5e1
rename intersphinx_disabled_{refs -> reftypes}
...
And change format for domains to {name}:*
2021-10-31 13:56:26 +01:00
Jakob Lykke Andersen
484d74ad97
intersphinx_disabled_refs, doc default value
2021-10-31 13:42:26 +01:00
Jakob Lykke Andersen
e192f6253a
intersphinx_disabled_refs, hard-code honor_disabled_refs in one more function
2021-10-31 13:40:39 +01:00
Jakob Lykke Andersen
778a3fe6a7
ntersphinx_disabled_refs, type rename
2021-10-31 13:26:38 +01:00
Jakob Lykke Andersen
cfbac2ceaa
intersphinx_disabled_refs, rename 'all' to '*'
2021-10-31 13:23:23 +01:00
Jakob Lykke Andersen
9e1ba751ec
intersphinx_disabled_refs, fix CHANGES
2021-10-31 13:16:57 +01:00
Jakob Lykke Andersen
0d9f4cd469
Generalize to disable specific refs as well.
2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen
84238dfd39
Remove intersphinx_disabled_domains from quickstart
2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen
c88c718397
Fix typo
2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen
f22faa7e06
Add intersphinx_disabled_domains
...
Fixes sphinx-doc/sphinx#2068
Replaces sphinx-doc/sphinx#8981
2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen
961f5af096
Intersphinx, refactoring
...
Also, when a reference is unresolved, don't strip the inventory prefix.
2021-10-31 13:15:46 +01:00