IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
18,177 Commits 2 Branches 219 Tags 163 MiB
1c124e0258
Commit Graph

18177 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
72e5090403
Merge pull request #9649 from jakobandersen/searchindex_fix 
Searchindex fix when objects have the same name
 2021-09-27 01:54:50 +09:00
Takeshi KOMIYA
45b2c699a0
Merge pull request #9676 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-09-26 20:15:48 +09:00
tk0miya
71af1dacc3 Update message catalogs 2021-09-26 00:10:41 +00:00
Takeshi KOMIYA
5fb6fb6039 Fix #9651: autodoc_typehints_description_target was confused by :returns: 
It only checks the existence of `:return:` field.  And it does not check
`:returns:` field.  It causes the absence of return types.
 2021-09-26 02:10:13 +09:00
Takeshi KOMIYA
5fb51fb146
Merge pull request #9668 from tk0miya/9655_mocked_object_having_doccomment 
Fix #9655: autodoc: mocked object having doc comment is warned unexpectedly
 2021-09-26 00:55:10 +09:00
Takeshi KOMIYA
de59a72fe6
Merge pull request #9665 from tk0miya/9664_autodoc_process_bases_injection 
Close #9664: autodoc: autodoc-process-bases supports reST snippet
 2021-09-26 00:54:42 +09:00
Jakob Lykke Andersen
cfc802048b search, update CHANGES 2021-09-25 11:02:24 +02:00
Jakob Lykke Andersen
a473c8e618 search, type fix 2021-09-25 10:59:50 +02:00
Jakob Lykke Andersen
b6e60d4993 search, store objects as array to retain all 2021-09-25 10:59:49 +02:00
Jakob Lykke Andersen
356583fe8f search, test update 2021-09-25 10:59:24 +02:00
Takeshi KOMIYA
699d03f597 Update CHANGES for PR #9670 2021-09-25 14:39:50 +09:00
Takeshi KOMIYA
d75e3171cd
Merge pull request #9670 from jonppe/fix-download-file-with-special-characters 
Fix download file with special characters
 2021-09-25 14:38:48 +09:00
Johannes Aalto
b2bd115dc8 Fix local file download by encoding URL 
Properly encode links to files with special characters for the user to
actually be able to download them.

The issue still remains for image files but the logic path
is quite different than with other files fix might involve changes
to docutils.

Fixes sphinx-doc/sphinx#3097

Signed-off-by: Johannes Aalto <ext-johannes.aalto@vaisala.com>
 2021-09-24 20:34:09 +03:00
Johannes Aalto
fa3b334ed0 Add test for encoding local file links with special characters 
Add test to make sure Sphinx uses proper URL encoding for
special characters in file names.

Use test_html_download() since it test_html5_output() doesn't
quite seem to have easy pattern to verify the contents of href
attribute.

Issue #3097

Signed-off-by: Johannes Aalto <ext-johannes.aalto@vaisala.com>
 2021-09-24 20:34:09 +03:00
Takeshi KOMIYA
bdc2112dbc Fix #9655: autodoc: mocked object having doc comment is warned unexpectedly 
A warning for mocked object should not be emitted if it has doc comment.
 2021-09-24 02:04:25 +09:00
Takeshi KOMIYA
9543962da6 Add doc for ObjectDescription (refs: #9662) 2021-09-23 12:56:09 +09:00
Takeshi KOMIYA
d13b86e02f Close #9664: autodoc: autodoc-process-bases supports reST snippet 
This allows to inject a reST snippet through autodoc-process-bases
event.  It helps to modify the base classes of any class to the expected
mark-up'ed text by custom extension.
 2021-09-23 10:59:01 +09:00
Takeshi KOMIYA
e79efef63a Fix #9657: autodoc: basecls for a subclass of mocked object is incorrect 2021-09-21 02:03:31 +09:00
Takeshi KOMIYA
274ee481ac
Merge pull request #9647 from tk0miya/9637_Builder.allow_parallel 
Fix #9637: Add Builder.allow_parallel to the list of builder APIs
 2021-09-20 17:02:49 +09:00
Takeshi KOMIYA
10b7f0e252 Fix #9607: autodoc: Incorrect base class detection 
In case of the descendants of generic class, the value of
obj.__orig_bases__ is incorrect because it returns original base
arguments for the child of the generic class instead of the target
class itself.

This uses obj.__dict__ to get the correct __orig_bases__ information.
 2021-09-20 13:20:26 +09:00
Takeshi KOMIYA
a05dc0b419
Merge pull request #9650 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-09-19 11:38:44 +09:00
tk0miya
9f329fb3c9 Update message catalogs 2021-09-19 00:10:12 +00:00
Takeshi KOMIYA
29ac4c1982 Fix #9637: Add Builder.allow_parallel to the list of builder APIs 2021-09-18 01:26:12 +09:00
Takeshi KOMIYA
3774c124f8 Update CHANGES for PR #9644 2021-09-18 01:21:13 +09:00
Takeshi KOMIYA
62fd91b8d1
Merge pull request #9644 from xmo-odoo/fix-sourcename-broken-getattr 
Protect `sphinx.ext.autodoc.get_sourcename` against misbehaving `__getattr__`
 2021-09-18 01:18:57 +09:00
Takeshi KOMIYA
506590d4ba
Merge pull request #9640 from tk0miya/9639_support_asyncgenfunction 
Close #9639: autodoc: Support asynchronous generator functions
 2021-09-18 01:03:34 +09:00
Takeshi KOMIYA
bebd6bdab1
Merge pull request #9633 from tk0miya/9630_autosummary_primary_domain 
Fix #9630: autosummary: Failed to build summary table if primary_domain is not 'py'
 2021-09-18 01:02:55 +09:00
Xavier Morel
69af4d2d00 Protect get_sourcename against misbehaving __getattr__ 2021-09-17 08:44:10 +02:00
Takeshi KOMIYA
ccfca458ea Close #9639: autodoc: Support asynchronous generator functions 2021-09-17 02:20:40 +09:00
Takeshi KOMIYA
bc012076b8 Fix #9630: autosummary: Failed to build summary table if primary_domain is not 'py' 
Autosummary generates reST code that uses raw `:obj:` xrefs to refer
the python objects in the summary table.  But they're fragile because
they assume the primary_domain=='py'.

This adds `:py:` prefix to these xrefs to make them robust.
 2021-09-14 23:59:47 +09:00
Takeshi KOMIYA
ed227d7d3c Fix #9630: autodoc: Failed to build xrefs if primary_domain is not 'py' 
Autodoc generates reST code that uses raw `:obj:` and `:class:` xrefs to
refer the classes and types.  But they're fragile because they assume
the primary_domain=='py'.

This adds `:py:` prefix to these xrefs to make them robust.
 2021-09-14 23:59:47 +09:00
Takeshi KOMIYA
ba2439a105 Bump version 2021-09-12 16:55:46 +09:00
Takeshi KOMIYA
cf38356a08 Bump version 2021-09-12 16:54:59 +09:00
Takeshi KOMIYA
21db4b1407 Bump to 4.2.0 final 2021-09-12 16:51:24 +09:00
Takeshi KOMIYA
2390ce6e1a CHANGES: Merge 4.1.3 (unreleased) to 4.2.0 2021-09-12 16:48:25 +09:00
Takeshi KOMIYA
b67624ec76
Merge pull request #9627 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-09-12 16:33:22 +09:00
tk0miya
50d7bfa6b8 Update message catalogs 2021-09-12 00:10:39 +00:00
Takeshi KOMIYA
260f217a3d
Merge pull request #9594 from hkuno/pr/no_empty_desc_4.x 
let user skip printing command description
 2021-09-11 19:08:37 +09:00
Takeshi KOMIYA
fb141c355f Update CHANGES for PR #9594 2021-09-11 18:54:29 +09:00
Takeshi KOMIYA
571929974a Add a testcase for #9694 2021-09-11 18:47:24 +09:00
Takeshi KOMIYA
c44ee0ebaa
Merge pull request #9611 from tk0miya/9560_NewType_module 
Close #9560: autodoc: Allow to refer NewType with modname in py310+
 2021-09-11 17:19:54 +09:00
Takeshi KOMIYA
8416813168
Merge pull request #9616 from jdufresne/fix-url 
Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|g
 2021-09-11 17:16:47 +09:00
Takeshi KOMIYA
3a67b49f5d Update CHANGES for PR #9617 2021-09-11 17:12:59 +09:00
James Knight
e01d914dbd themes: use noscript for search js notification 
The "search.html" template will generate a warning admonition about
requiring JavaScript for search and automatically hiding the element
when supported. While functional, if a client renders the page slowly,
the warning notification may be visible to the user for a moment.

Instead of relying on JavaScript to suppress this warning, use a
`noscript` tag to hide the warning for clients who do not support
JavaScript. This also has the benefit of one less JavaScript call
required by a client.

Signed-off-by: James Knight <james.d.knight@live.com>
 2021-09-11 17:04:57 +09:00
Takeshi KOMIYA
293beecc06
Merge pull request #9619 from cclauss/patch-1 
setup.py: Fix broken url on the Sphinx PyPI page
 2021-09-11 16:55:50 +09:00
Takeshi KOMIYA
4442f32e7a
Merge pull request #9621 from cclauss/codespell-again 
Fix typos discovered by codespell (again)
 2021-09-11 16:54:45 +09:00
Christian Clauss
d2c95dfd0c overridden 2021-09-08 02:33:10 +02:00
Christian Clauss
86583c578c Fix typos discovered by codespell 2021-09-08 02:15:25 +02:00
Christian Clauss
95f47d8b2e
setup.py: Fix broken url on the PyPI page 2021-09-07 19:36:07 +02:00
Jon Dufresne
7dd112b110 Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|g 
https://sphinx-doc.org is unreachable, but is linked from the PyPI page:
https://pypi.org/project/Sphinx/. Switch to https://www.sphinx-doc.org/
instead.
 2021-09-06 13:15:48 -07:00