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,153 Commits 2 Branches 219 Tags 163 MiB
1fbca49970
Commit Graph

18153 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
1d72196bfb
Merge pull request #9184 from tk0miya/9176_docs 
doc: Update CHANGES and docs for PR #9176
 2021-05-10 02:03:08 +09:00
Takeshi KOMIYA
2ee634bfda refactor: Add Optional to type annotations 2021-05-10 02:01:24 +09:00
Takeshi KOMIYA
b88187de34
Merge pull request #9182 from tk0miya/refactor_autodoc 
refactor: autodoc: Remove backslashes from the tail of line
 2021-05-10 01:50:15 +09:00
Takeshi KOMIYA
98c756b33f
Merge pull request #9180 from tk0miya/9175_special_member_for_module 
Fix #9175: autodoc: Special member is not documented in the module
 2021-05-10 01:49:36 +09:00
Takeshi KOMIYA
75161478c7 Fix #8380: html search: tags for search result are broken 2021-05-09 22:14:04 +09:00
Takeshi KOMIYA
ab6ec71a89 Fix #9188: autosummary: warning if list is set to autosummary_generate 2021-05-09 22:05:17 +09:00
Takeshi KOMIYA
23fcb91c2f Fix #9189: autodoc: crashed by ValueError on generating signature of property 
Autodoc is crashed if `inspect.signature` raises ValueError on
generating signature from a property of the class.  It seems the
original code re-raise the exception meaningless.  So this ignores it
even if raised.
 2021-05-09 21:32:56 +09:00
Takeshi KOMIYA
08c65d4de2 i18n: Pull translations via GitHub Actions automatically 2021-05-09 18:20:41 +09:00
Takeshi KOMIYA
effedafabe i18n: Push translations via GitHub Actions automatically 2021-05-09 17:15:36 +09:00
Ashley Whetter
28d3f8136e autodoc.typehints can accurately represent overloads 2021-05-08 21:34:25 -07:00
Takeshi KOMIYA
78dbe075a7 Merge branch '4.0.x' into 4.x 2021-05-09 12:22:55 +09:00
Takeshi KOMIYA
f73e061d2b Bump version 2021-05-09 12:21:32 +09:00
Takeshi KOMIYA
a317d0037c Bump to 4.0.0 final 2021-05-09 12:20:11 +09:00
Takeshi KOMIYA
09bb98689c Update message catalogs 2021-05-09 12:17:17 +09:00
Takeshi KOMIYA
ac51fe8d2a doc: Update CHANGES and docs for PR #9176 2021-05-09 02:13:15 +09:00
Takeshi KOMIYA
4b197928aa
Merge pull request #9176 from mart-e/4-add-warning-i18n 
[IMP] util: detect incorrect locale_dirs path
 2021-05-09 01:49:57 +09:00
Takeshi KOMIYA
80fb2c051c refactor: autodoc: Remove backslashes from the tail of line 2021-05-08 22:09:39 +09:00
Martin Trigaux
bda29f1a83 [IMP] util: detect incorrect locale_dirs path 
In case the config is incorrect (e.g. wrong relative path), it is silently ignored.
This makes it easier for debugging.
 2021-05-08 13:03:29 +02:00
Takeshi KOMIYA
d69c35b1a4 Fix #9175: autodoc: Special member is not documented in the module 
The special members are not treated as "attributes".  So they're not
handled by DataDocumenter.  This moves the detection to the earlier
step of filter_members().
 2021-05-08 17:33:33 +09:00
Takeshi KOMIYA
f47bf1471d
Merge pull request #9178 from sphinx-doc/dependabot/npm_and_yarn/lodash-4.17.21 
Bump lodash from 4.17.19 to 4.17.21
 2021-05-08 00:46:39 +09:00
dependabot[bot]
9c1a58d5e1
Bump lodash from 4.17.19 to 4.17.21 
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.19 to 4.17.21.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.19...4.17.21)

Signed-off-by: dependabot[bot] <support@github.com>
 2021-05-07 13:34:26 +00:00
Manuel Kaufmann
d01e776c81 Add Sphinx.add_html_assets_in_all_pages 
This new method in the `Sphinx` object allows extensions to communicate to
Sphinx that it's preferred to include HTML assets in all the pages. However,
it's extensions developers' responsability to follow this config and decide
whether or not include the assets required.

Extensions developers' can check `Sphinx.html_assets_in_all_pages` together with
any other logic they may have to decide if the assets will be included in the
rendered page or not.

Closes #9115
 2021-05-06 15:21:12 +02:00
Takeshi KOMIYA
512743525c Update CHANGES for PR #9131 2021-05-06 00:23:37 +09:00
Takeshi KOMIYA
829de019c5
Merge pull request #9162 from tk0miya/jinja2-3.0 
Support jinja2-3.0
 2021-05-06 00:02:24 +09:00
Takeshi KOMIYA
d82c8a7890
Merge pull request #9131 from RuRo/feature/glob-nitpick-ignore 
Ignore nitpick warnings with regular expressions using `nitpick_ignore_regex`
 2021-05-05 23:43:46 +09:00
Takeshi KOMIYA
d006c66e23 Update CHANGES for PR #9146 2021-05-05 22:28:57 +09:00
Takeshi KOMIYA
1f860cb77e
Merge pull request #9146 from pbudzyns/autosummary-iattr-include 
Autosummary to include instance attributes
 2021-05-05 22:27:28 +09:00
Takeshi KOMIYA
77da494173
Merge pull request #9153 from tk0miya/9082_python3.10.0a7 
Revert "test: Disable testing with python3.10"
 2021-05-05 22:22:30 +09:00
Takeshi KOMIYA
531a5ae9ef test: Adjust type annotataions in python 3.10.0b1 2021-05-05 22:11:41 +09:00
David Ham
8ba93dd21f Refactor to one environment per class. 
Also rename sphinxcontainer to sphinxclass.
 2021-05-04 16:32:17 +01:00
Takeshi KOMIYA
43434a086c
Merge pull request #9164 from tk0miya/refactor_Optional 
refactor: Add Optional to type annotations
 2021-05-04 21:04:16 +09:00
Takeshi KOMIYA
50d027a036 Update CHANGES for PR #9167 2021-05-04 20:24:30 +09:00
Takeshi KOMIYA
a0d60360f4
Merge pull request #9167 from bonartm/fix_css_specific_page 
html: fix missing reverting when adding css files to specific page
 2021-05-04 20:18:59 +09:00
Malte Bonart
a7c5a3a88b fix missing underscore 
fix missing reverting when adding css files via app.add_css_file in a html-page-context event
 2021-05-04 08:42:01 +02:00
Takeshi KOMIYA
85f58874ec Support jinja2-3.0 
Since jinja2-3.0, some utility functions like contextfunction and
environmentfilter are renamed to new name.  This follows the updates to
support jinja2-3.0 or above.
 2021-05-04 14:37:41 +09:00
David Ham
1b03748f68 Grammar. 2021-05-03 22:29:11 +01:00
David Ham
31f7eae822 Support containers in LaTeX output. 
Support containers in the LaTeX writer by outputting the start and end
of a LaTeX group, wrapping the beginning and end of a LaTeX
environment. The class name(s) are passed as an argument to the
environment.
 2021-05-03 21:50:22 +01:00
Takeshi KOMIYA
930bf6c327 refactor: Add Optional to type annotations 2021-05-03 22:41:19 +09:00
Takeshi KOMIYA
f31af4b815 Merge branch '4.0.x' into 4.x 2021-05-03 22:31:51 +09:00
Takeshi KOMIYA
110fe1797c
Merge pull request #9159 from tk0miya/8588_nested_autodoc_type_aliases 
Fix #8588: autodoc_type_aliases does not support dotted name
 2021-05-03 22:30:01 +09:00
Takeshi KOMIYA
38758dbcce
Merge pull request #9158 from tk0miya/8597_metadata_only_docstring 
Fix #8597: autodoc: metadata only docstring is treated as undocumented
 2021-05-03 22:26:11 +09:00
Takeshi KOMIYA
30efa3d947
Merge branch '4.x' into 8597_metadata_only_docstring 2021-05-03 22:11:10 +09:00
Takeshi KOMIYA
cb7b41f151
Merge pull request #9157 from tk0miya/8872_stacked_singledispatch 
Fix #8872: autodoc: stacked singledispatches are wrongly rendered
 2021-05-03 22:10:41 +09:00
Takeshi KOMIYA
caa6579dbd Fix #8872: autodoc: stacked singledispatches are wrongly rendered 
When multiple singledispatch decorators are stacked, the first typehints
are copied to the subsequent definitions unexpectedly.

Now autodoc generates a dummy function not to affect typehints to
subsequent functions.
 2021-05-03 21:51:19 +09:00
Takeshi KOMIYA
cfb9183715 Update dependency: jinja2 < 3.0 and MarkupSafe < 2.0 
Jinja2 and MarkupSafe have a plan to major release in the near future.
And it will introduce some changes for its APIs.  To lessen the noise
of the DeprecationWarnings, this pins the versions to current stable
release.
 2021-05-03 21:48:13 +09:00
Takeshi KOMIYA
05abdad749
Merge pull request #9161 from tk0miya/pin_jinja2 
Update dependency: jinja2 < 3.0 and MarkupSafe < 2.0
 2021-05-03 21:47:27 +09:00
Takeshi KOMIYA
53c6353714
Merge pull request #9163 from tk0miya/extlinks_warning 
Fix test: deprecation warning for extlinks
 2021-05-03 21:46:55 +09:00
Takeshi KOMIYA
8d54010675 Fix test: deprecation warning for extlinks 2021-05-03 18:52:19 +09:00
Takeshi KOMIYA
28ab5f233c Close #8588: autodoc: autodoc_type_aliases supports dotted name 
It allows users to define an alias for a class with module name
like `foo.bar.BazClass`.
 2021-05-03 18:47:47 +09:00
Takeshi KOMIYA
7acfc7826f Update dependency: jinja2 < 3.0 and MarkupSafe < 2.0 
Jinja2 and MarkupSafe have a plan to major release in the near future.
And it will introduce some changes for its APIs.  To lessen the noise
of the DeprecationWarnings, this pins the versions to current stable
release.
 2021-05-03 13:56:23 +09:00