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,147 Commits 2 Branches 219 Tags 163 MiB
50dd03d640
Commit Graph

18147 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Jakob Lykke Andersen
50dd03d640
Merge pull request #9693 from jakobandersen/c-info-field 
C, info-fields
 2021-10-01 20:25:11 +02:00
Jakob Lykke Andersen
57fad5c044 C, update documentation for info-fields 2021-10-01 18:38:30 +02:00
Jakob Lykke Andersen
65aa3f7f51 C, fix retvals info-field to be collapsible 2021-10-01 18:38:14 +02:00
Jakob Lykke Andersen
8ed9ebc939 C, add CHANGES entry for sphinx-doc/sphinx#9691 2021-10-01 17:47:08 +02:00
Jakob Lykke Andersen
dd53cd2f8c C, move info-fields from all objects to just function and macro 2021-10-01 17:45:10 +02:00
Jakob Lykke Andersen
063dcfd9ec
Merge pull request #9691 from teslabs/c-domain-retval 
C, add support for return value list
 2021-10-01 17:40:12 +02:00
Gerard Marull-Paretas
3387f3b1aa
C, add support for return value list 
Add support for a new doc field type that allows to display a list of
return values.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
 2021-10-01 10:33:32 +02:00
Takeshi KOMIYA
0424210614 Update CHANGES for PR #9678 2021-10-01 02:42:16 +09:00
Takeshi KOMIYA
ea8b3d3d5f
Merge pull request #9678 from hoefling/fix-linkcheck-warnings 
Don't print file extension twice in linkcheck warnings
 2021-10-01 02:41:17 +09:00
Takeshi KOMIYA
b639b1d751
Merge pull request #9684 from ghassanmas/patch-1 
doc: update description
 2021-10-01 02:40:40 +09:00
Ghassan Maslamani
d20646194c doc: update description 
Update description about how `conf.py` is loaded/executed
 2021-09-30 13:43:09 +03:00
Takeshi KOMIYA
c1f8afafe1
Merge pull request #9687 from tk0miya/9500_latexpdf_on_windows 
Fix #9500: LaTeX: Failed to build Japanese document on Windows
 2021-09-30 18:35:53 +09:00
Takeshi KOMIYA
3cde4871d3 Fix #9500: LaTeX: Failed to build Japanese document on Windows 
At present, LaTeX builder generates a Makefile for PDFLaTeX instead of
upLaTeX in building Japanese document on Windows.  This adds upLaTeX
support to Makefile for Windows.
 2021-09-30 18:00:57 +09:00
oleg.hoefling
36a6fcaef1
don't print file extension twice in linkcheck warnings 
Signed-off-by: oleg.hoefling <oleg.hoefling@gmail.com>
 2021-09-27 22:12:57 +02:00
Takeshi KOMIYA
f34eb492a3
Merge pull request #9654 from tk0miya/9607_incorrect_orig_bases 
Fix #9607: autodoc: Incorrect base class detection
 2021-09-27 02:33:21 +09:00
Takeshi KOMIYA
d288907fd1
Merge branch '4.x' into 9607_incorrect_orig_bases 2021-09-27 02:21:14 +09:00
Takeshi KOMIYA
4a9e015fc6
Merge pull request #9658 from tk0miya/9657_qualname_of_mock 
Fix #9657: autodoc: basecls for a subclass of mocked object is incorrect
 2021-09-27 02:20:47 +09:00
Takeshi KOMIYA
0ea135e6d4
Merge branch '4.x' into 9657_qualname_of_mock 2021-09-27 01:58:44 +09:00
Takeshi KOMIYA
232dbe41c5
Merge pull request #9673 from tk0miya/9651_autodoc_typehints_description_target 
Fix #9651: autodoc_typehints_description_target was confused by :returns:
 2021-09-27 01:58:10 +09:00
Takeshi KOMIYA
c0333d4464
Merge pull request #9666 from tk0miya/9662_docs_for_ObjectDescription 
Add doc for ObjectDescription (refs: #9662)
 2021-09-27 01:57:36 +09:00
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