Commit Graph

16735 Commits

Author SHA1 Message Date
jfbu
628c58abef Prepare for scope-limited footnote numbering 2021-02-06 10:45:50 +01:00
jfbu
9c823478e0 Update CHANGES 2021-02-05 20:39:32 +01:00
jfbu
98f4732a98 LaTeX: make all references to explicitly numbered footnote clickable 2021-02-05 20:26:17 +01:00
Takeshi KOMIYA
ad5b0babd7 refactor: linkcheck: Remove unused attribute HyperlinkAvailabilityCheckWorker.app 2021-02-06 01:34:20 +09:00
Takeshi KOMIYA
163c7bbdc1
Merge pull request #8806 from tk0miya/refactor_linkcheck5
refactor: linkcheck: Separate worker feature from builder class
2021-02-06 01:33:52 +09:00
Takeshi KOMIYA
84130fff40
Fix typo
Co-authored-by: François Freitag <mail@franek.fr>
2021-02-06 01:24:16 +09:00
jfbu
eb91fd292f Update CHANGES 2021-02-05 16:49:41 +01:00
jfbu
a0b0a08e38 LaTeX footnotes from caption titles now hyperlinked in PDF
This is fifth item of #2616
2021-02-05 16:45:12 +01:00
Takeshi KOMIYA
f02fb7a8cc refactor: linkcheck: Separate worker feature from builder class
To reduce the complexity of the linkcheck builder, this separates
the worker feature from the builder class.
2021-02-05 22:52:28 +09:00
Takeshi KOMIYA
a39b5f08e9
Merge pull request #8822 from tk0miya/8813_ExtensionError
Close #8813: Show what extension caused it on errors on event handler
2021-02-05 22:48:57 +09:00
Takeshi KOMIYA
ed2af230e4
Merge pull request #8823 from tk0miya/8511_readonly_testing
Support testing from read-only filesystems
2021-02-05 22:48:29 +09:00
Takeshi KOMIYA
50b0cec41c
Merge pull request #8826 from francoisfreitag/linkcheck-result
Formalize linkcheck CheckResult into a NamedTuple
2021-02-05 22:47:58 +09:00
Takeshi KOMIYA
3b4b7378d7
Merge pull request #8827 from thibaudcolas/patch-2
Fix broken "Extend" link in site header
2021-02-05 22:47:04 +09:00
Thibaud Colas
00e2c2e250
Fix broken "Extend" link in site header
Spotted while navigating https://www.sphinx-doc.org/en/master/.
2021-02-04 22:04:17 +00:00
François Freitag
b12a0f33ef
Formalize linkcheck CheckResult into a NamedTuple 2021-02-04 21:53:49 +01:00
Takeshi KOMIYA
1fc7bc6b1e test: change permissions of testfiles only $SPHINX_READONLY_TESTDIR set 2021-02-05 00:39:29 +09:00
Takeshi KOMIYA
32257ee524 test: Apply umask to Path.copytree() 2021-02-05 00:17:44 +09:00
Jean-François B
ec5b169312
Merge pull request #8821 from jfbu/latex_sync_with_footnotehyper
Sync with footnotehyper 1.1d
2021-02-04 16:14:41 +01:00
Takeshi KOMIYA
654458b525 Close #8813: Show what extension caused it on errors on event handler
Show the module name of the event handler on the error inside it to let
users know a hint of the error.
2021-02-04 22:35:48 +09:00
Takeshi KOMIYA
284d9e703b refactor: Fix the right hand value of autodoc options should be None 2021-02-04 22:35:29 +09:00
Takeshi KOMIYA
50717a2cfd Fix typo 2021-02-04 22:33:00 +09:00
Takeshi KOMIYA
572c9a403c Update CHANGES for PR #8297 2021-02-04 22:27:02 +09:00
Takeshi KOMIYA
0d50b97fa3
Merge pull request #8297 from pbudzyns/exclude-members-fix
Local autodoc options override or extend autodoc_default_options.
2021-02-04 22:24:52 +09:00
jfbu
39e4ea23c6 Sync with footnotehyper 1.1d
This fixes a problem introduced at 1.1b which could case latex build
crash in case of extra user packages.

It also improves compatibility with babel + french.
2021-02-04 14:14:37 +01:00
Takeshi KOMIYA
9ed3219ea4
Merge pull request #8792 from tk0miya/8774_refactor_linkcheck
refactor: linkcheck: Skip queuing ignored URIs
2021-02-04 21:54:52 +09:00
Takeshi KOMIYA
421c6bb473 refactor: linkcheck: Skip queuing ignored URIs
To make checker-thread simpler, this checks the URI is ignored before
queueing.
2021-02-04 01:09:19 +09:00
Takeshi KOMIYA
1cf915f7dd
Merge pull request #8804 from tk0miya/8791_linkcheck_docname_isnt_shown
linkcheck: The docname of hyperlink is not displayed (refs: #8791)
2021-02-02 23:09:03 +09:00
Takeshi KOMIYA
000ed29ff7
Merge pull request #8812 from jfbu/latex_url_as_footnotes_in_signatures
Latex url as footnotes in signatures
2021-02-02 22:58:37 +09:00
Takeshi KOMIYA
54f31891c2
Merge pull request #8811 from tk0miya/8782_xref_in_todolist
Fix #8782: todo: Cross references in todolist get broken
2021-02-02 22:54:14 +09:00
jfbu
c8eba61fe9 Update CHANGES 2021-02-02 00:13:48 +01:00
jfbu
7c7032dd05 Extend latex footnotes unit test 2021-02-02 00:10:45 +01:00
jfbu
c3b44dc1c8 LaTeX: save footnotes arising from inside function signatures
if latex_show_urls == 'footnote'
2021-02-01 23:49:40 +01:00
jfbu
fbe24647e4 LaTeX: sync with upstream footnotehyper 1.1c
Incorporate 1.1c fix to usage of savenotes around a mid-paragraph list,
and also the 1.0..1.1 upstream patch about usage within minipages while
we are at it.
2021-02-01 23:25:50 +01:00
Takeshi KOMIYA
a65b333c87 Fix #8782: todo: Cross references in todolist get broken
On resolving cross reference nodes in todolist, some of them get broken
because todo extension does not rewrite the "refdoc" attribute of them.
2021-02-02 01:27:11 +09:00
Takeshi KOMIYA
f803266d63
Merge pull request #8805 from tk0miya/8775_workaround
Fix #8775: Avoid the crash of autodoc caused by type union operator
2021-02-01 21:35:04 +09:00
Takeshi KOMIYA
223f59b3c5
Merge pull request #8802 from tk0miya/8775_pydomain_pep604
py domain: Support type union operator (PEP-604) (refs: #8775)
2021-02-01 21:22:38 +09:00
Takeshi KOMIYA
7ca5248057 Fix #8775: Avoid the crash of autodoc caused by type union operator
The type union operator (PEP-604) causes autodoc crashed in python 3.9
or below because of the syntax is not suppoerted yet in the interpreters.
Internally, `typing.get_type_hints()` raises TypeError on evaluating the
annotation by BitOr operator for types.

To avoid the crash, this adds a fallback not to evaluate the annotations
and keep as is.  As a side effect, `autodoc_type_aliases` will not work
for the modules and classes that uses type union operator for their
annotations.
2021-02-01 21:21:56 +09:00
Takeshi KOMIYA
2956f19674
Merge pull request #8803 from tk0miya/8775_autodoc_type_union_operator
autodoc: Support type union operator (PEP-604) (refs: #8775)
2021-02-01 21:19:45 +09:00
Takeshi KOMIYA
ce7be36a12
Merge pull request #8801 from tk0miya/8800_docstring_for_uninitialized_attribute_on_superclass_ignored
Fix #8800: autodoc: Uninitialized attributes in superclass are recognized as undocumented
2021-02-01 21:15:07 +09:00
Takeshi KOMIYA
2c2b8c1154 py domain: Support type union operator (PEP-604) (refs: #8775)
Upgrade annotation parser for python domain to support type union
operator introduced in PEP-604.  It's available on all python
interpreters.
2021-02-01 21:12:29 +09:00
Takeshi KOMIYA
6d8c9183fa Fix #8800: autodoc: Uninitialized attributes in superclass are recognized as undocumented
Unintentionally, uninitialized attributes defined at superclasses are
recognized as undocumented in the filtering step.  Therefore, they are
filtered if `:undoc-members:` option given.
2021-02-01 21:06:07 +09:00
Takeshi KOMIYA
7ca279e33a
Merge pull request #8799 from tk0miya/refactor_util_get
refactor: AttributeError handling for sphinx.util.inspect.get* is not needed
2021-02-01 21:04:02 +09:00
pbudzyns
fd6587d5e9 rebase and fix tests 2021-02-01 10:58:09 +01:00
pbudzyns
270921d73a Merge remote-tracking branch 'upstream/3.x' into exclude-members-fix 2021-02-01 10:46:44 +01:00
pbudzyns
35adeeff41 update docs 2021-02-01 10:28:01 +01:00
pbudzyns
8d380cadc7 check if autodoc_defaults are str, fix tests 2021-02-01 09:46:19 +01:00
Takeshi KOMIYA
d3101dd6f7
Merge pull request #8472 from tk0miya/8446_escape_spaces_inside_desc_signatures
Fix #8446: html: consecutive spaces are displayed as single space
2021-02-01 01:44:48 +09:00
Takeshi KOMIYA
af6ed52ca1
Merge branch '3.x' into 8446_escape_spaces_inside_desc_signatures 2021-02-01 01:24:02 +09:00
Takeshi KOMIYA
88c6330900 linkcheck: The docname of hyperlink is not displayed (refs: #8791)
Currently, linkcheck displays the status of hyperlinks.  But it is hard
to search where the hyperlink is written because only line numbers are
shown as the location for the link.

This displays the docname of the link too.
2021-02-01 01:15:53 +09:00
Takeshi KOMIYA
434cc60ae5
Merge pull request #8794 from tk0miya/refactor_linkcheck3
refactor: linkcheck: Update type annotations
2021-01-31 23:45:59 +09:00