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
17,731 Commits 2 Branches 219 Tags 163 MiB
eda4b1cfc4
Commit Graph

17731 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Juan Luis Cano Rodríguez
2b0131d0bc Be consistent with virtual environment name 2021-05-31 16:29:55 +02:00
Juan Luis Cano Rodríguez
c8a3a2535a Be consistent with directory names 2021-05-31 16:29:09 +02:00
Juan Luis Cano Rodríguez
95519b3c06 Links to relevant reST syntax explanation 2021-05-31 16:26:21 +02:00
Juan Luis Cano Rodríguez
1da5ab5808 Style fixes 
Co-authored-by: Steve Piercy <web@stevepiercy.com>
 2021-05-31 16:26:21 +02:00
Takeshi KOMIYA
e878299cc6
Merge pull request #9259 from tk0miya/deprecate_app 
deprecate sphinx.ext.autosummary._app
 2021-05-31 02:42:13 +09:00
Takeshi KOMIYA
46c2e45aa6 deprecate sphinx.ext.autosummary._app 2021-05-31 02:09:10 +09:00
Takeshi KOMIYA
5c275191b6
Merge pull request #9282 from tk0miya/9280_exceptions 
Fix #9280: py domain: "exceptions" module is not displayed
 2021-05-30 22:09:34 +09:00
Takeshi KOMIYA
7dbe8ebf1b
Merge pull request #9281 from tk0miya/9272_enum_for_defargs 
Close #9272: autodoc: Render enum values for the default argument value better
 2021-05-30 22:08:31 +09:00
Takeshi KOMIYA
9a9433e403 Fix #9283: autodoc: failed to build doc for attribute not commented 
Autoattribute directive should check the existence of instance attribute
that is defined inside __init__() but not having comments before
accessing it.
 2021-05-30 19:48:11 +09:00
Takeshi KOMIYA
429d0f7171
Merge pull request #9284 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-05-30 12:47:30 +09:00
tk0miya
341f66e3a2 Update message catalogs 2021-05-30 00:22:29 +00:00
Takeshi KOMIYA
201f61f722 Fix #9280: py domain: "exceptions" module is not displayed 
Since v0.2, python domain gives a special treatment for the exceptions
module to suppress its name on documenting exception classes.  It had
been worthy on python2 era.  But the module has been removed since
python3.  Therefore, the special treatment becomes harmful for user
libraries.  This removes it to render module names correctly.

Note: Now we've only supported python3.  So this is not incompatible.
 2021-05-30 03:46:55 +09:00
Takeshi KOMIYA
2809b30c17 Update CHANGES for PR #9271 2021-05-30 03:15:40 +09:00
Takeshi KOMIYA
d961a380d8
Merge pull request #9271 from rdt12/pyramid-logo 
Closes #9270: pyramid theme generates incorrect logo links
 2021-05-30 03:12:45 +09:00
Takeshi KOMIYA
02d3e9836c
Update CHANGES 2021-05-30 02:22:45 +09:00
Takeshi KOMIYA
31ec519d38 Close #9272: autodoc: Render enum values for the default argument value better 2021-05-30 02:15:28 +09:00
Juan Luis Cano Rodríguez
bfca913f16 Move virtual environment explanation to installation 2021-05-29 19:15:15 +02:00
Takeshi KOMIYA
8ec06e9a1b
Merge pull request #9277 from greyli/fix-intl-docs 
Fix typo in doc/intl.rst
 2021-05-30 00:39:41 +09:00
Juan Luis Cano Rodríguez
5b3e5d887b Amend code documentation introduction 2021-05-29 13:44:26 +02:00
Juan Luis Cano Rodríguez
d6cb2d0c38 Use more appropriate terminology for emphasized text 2021-05-29 13:22:36 +02:00
Juan Luis Cano Rodríguez
bfd3b51435 Style 2021-05-29 13:22:21 +02:00
Juan Luis Cano Rodríguez
1631291b0e Consistent heading styles 2021-05-29 13:21:50 +02:00
Juan Luis Cano Rodríguez
ffa8e110d0 Add index tweaks 2021-05-27 21:32:49 +02:00
Juan Luis Cano Rodríguez
337ee6afaa Style 2021-05-27 18:17:33 +02:00
Juan Luis Cano Rodríguez
39b5564c63 Beginning of the tutorial, tweaks to introduction 2021-05-27 18:15:26 +02:00
Grey Li
6a0dae08d0
Fix typo in doc/intl.rst 
The pot files are in the gettext folder instead of locale folder.
 2021-05-27 17:28:10 +08:00
Juan Luis Cano Rodríguez
70ee9bcd6a Tutorial link in front page, audience, objectives, and prerequisites 2021-05-26 21:25:38 +02:00
Ron Tapia
7c55559028 Closes #9270: pyramid theme generates incorrect logo links 2021-05-25 13:24:33 -04:00
Takeshi KOMIYA
830b3fbe2b
Merge pull request #9261 from tk0miya/9250_inherited_docstring 
Fix #9250: autodoc: The inherited method not having docstring is wrongly parsed
 2021-05-24 01:24:23 +09:00
Takeshi KOMIYA
27e0122f08
Merge pull request #9263 from tk0miya/remove_RemovedInSphinx40Warning 
refactor: Remove RemovedInSphinx40Warning
 2021-05-24 01:22:48 +09:00
Takeshi KOMIYA
80846c2ccc
Merge pull request #9265 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-05-23 12:51:17 +09:00
tk0miya
eec29c68af Update message catalogs 2021-05-23 00:11:48 +00:00
Takeshi KOMIYA
c579a5eb6a refactor: Remove RemovedInSphinx40Warning 2021-05-23 02:31:58 +09:00
Takeshi KOMIYA
4f5ab7c1bb Merge branch '4.0.x' into 4.x 2021-05-23 02:31:24 +09:00
Takeshi KOMIYA
de64bfdeac
Merge pull request #9264 from tk0miya/circleci 
CircleCI: Test with python 3.8
 2021-05-23 02:31:07 +09:00
Takeshi KOMIYA
3ef5fb30a0 CircleCI: Test with python 3.8 
From now on, Sphinx will be tested with python3.8 and Ubuntu-20.04 in
CircleCI.
 2021-05-23 02:21:32 +09:00
Takeshi KOMIYA
2ddc1d0681
Merge pull request #9258 from tk0miya/1874_piped_types_in_info-field-list 
Close #1874: py domain: Support union types using `|` in info-field-list
 2021-05-23 00:42:56 +09:00
Takeshi KOMIYA
0fb8e33f32 Fix #9250: autodoc: The inherited method not having docstring is wrongly parsed 
`sphinx.util.inspect.getdoc()` clean the docstring up if the method is
inherited and not having docstring.  That causes indentations are
removed on processing it.
 2021-05-23 00:39:05 +09:00
Takeshi KOMIYA
4d90277c49
Merge pull request #9254 from tk0miya/refactor_find_pending_xref_conditions 
refactor: reduce calls of find_pending_xref_conditions (refs: #9240)
 2021-05-22 16:29:50 +09:00
Takeshi KOMIYA
5a8dec457a refactor: reduce calls of find_pending_xref_conditions (refs: #9240) 
After #9246, `find_pending_xref_conditions()` should be only called from
intended modules.  At present, the Python Domain is the only module to
call it intendedly.  Therefore, this removes the needless calls of the
utility function from "unintended" modules.
 2021-05-22 15:34:30 +09:00
Takeshi KOMIYA
abe5ab4fa7
Merge pull request #9242 from tk0miya/refactor_env2 
refactor: Make the app argument for BuildEnvironment required
 2021-05-22 02:22:42 +09:00
Takeshi KOMIYA
63fbfb02f1 refactor: Make the app argument for BuildEnvironment required 
At present, some attributes of env object are considered as optional
because they have been initialized by None on the constructor.  But
they have always been fullfilled actually.

To be clear the type hints of the env object, this makes the `app`
argument for the BuildEnvironment class required.  It can ensure the
attributes of env object are not optional.
 2021-05-22 02:09:49 +09:00
Takeshi KOMIYA
aba3a33645
Merge pull request #9253 from tk0miya/9252_update_docs 
Fix #9252: doc: Update explanation of highlight_language
 2021-05-22 01:57:11 +09:00
Takeshi KOMIYA
a1b0e55548 Close #1874: py domain: Support union types using | in info-field-list 2021-05-22 01:55:43 +09:00
Takeshi KOMIYA
06107f838c Merge branch '4.0.x' into 4.x 2021-05-20 22:00:06 +09:00
Takeshi KOMIYA
a7ec37cae1 Bump version 2021-05-20 21:58:59 +09:00
Takeshi KOMIYA
a55816deb5 Bump to 4.0.2 final 2021-05-20 21:57:27 +09:00
Takeshi KOMIYA
4d061f2b49 Fix #9252: doc: Update explanation of highlight_language 2021-05-20 02:07:01 +09:00
Takeshi KOMIYA
c44140b4e3 Update CHANGES for PR #9240 2021-05-20 02:03:33 +09:00
Takeshi KOMIYA
d2d2d7bde3 Merge branch '4.0.x' into 4.x 2021-05-19 23:14:21 +09:00