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,458 Commits 2 Branches 219 Tags 163 MiB
8ba93dd21f
Commit Graph

17458 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
David Ham
8ba93dd21f Refactor to one environment per class. 
Also rename sphinxcontainer to sphinxclass.
 2021-05-04 16:32:17 +01: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
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
Takeshi KOMIYA
469def56b6 Fix #8597: autodoc: metadata only docstring is treated as undocumented 
The metadata in docstring is invisible content. Therefore docstring
having only metadata should be treated as undocumented.
 2021-05-02 23:17:58 +09:00
Takeshi KOMIYA
b237e78f9c
Merge pull request #9154 from tk0miya/8107_class-doc-from 
Close #8107: autodoc: Add class-doc-from option to autoclass directive
 2021-05-02 20:31:51 +09:00
Takeshi KOMIYA
30237c004d Update CHANGES for PR #9120 2021-05-02 18:32:02 +09:00
Takeshi KOMIYA
11d3a45ba2
Merge pull request #9120 from V0lantis/feature/selecting_usage 
Feature:
 2021-05-02 18:25:09 +09:00
Takeshi KOMIYA
d8a9f243e2 Close #8107: autodoc: Add class-doc-from option to autoclass directive 
Add `class-doc-from` option to the `autoclass` directive to control
the content of the specific class.  It takes `class`, `init`, and `both`
like `autoclass_content`.
 2021-05-01 14:53:06 +09:00
Takeshi KOMIYA
d656acaba3
Merge pull request #9144 from tk0miya/refactor_linkcheck2 
refactor: linkcheck: Call write_linkstat() at the top of process_result()
 2021-05-01 01:32:43 +09:00
Takeshi KOMIYA
55b55fd45e
Merge pull request #9150 from webknjaz/patch-1 
Mention that aiohttp uses its own custom theme
 2021-05-01 01:31:24 +09:00
Takeshi KOMIYA
7bc14b596e
Merge pull request #9143 from tk0miya/refactor_linkcheck 
refactor: linkcheck: Use attributes of CheckResult in process_result()
 2021-05-01 01:30:56 +09:00
Sviatoslav Sydorenko
6e90d8a3ab
Mention that aiohttp uses its own custom theme 2021-04-29 23:50:25 +02:00
Takeshi KOMIYA
29038c9d4c refactor: linkcheck: Call write_linkstat() at the top of process_result() 2021-04-29 18:19:38 +09:00
Takeshi KOMIYA
a7d3e9684d refactor: linkcheck: Use attributes of CheckResult in process_result() 2021-04-29 18:01:42 +09:00
Takeshi KOMIYA
af6e63ab70 Merge branch '4.0.x' into 4.x 2021-04-29 15:06:16 +09:00
Takeshi KOMIYA
742a2e0c0a Bump version 2021-04-29 15:04:53 +09:00
Takeshi KOMIYA
07e84752c7 Bump to 4.0.0 beta2 2021-04-29 15:03:44 +09:00
Takeshi KOMIYA
3b12911e0d
Merge pull request #9125 from tk0miya/unpin_docutils-0.17 
Support docutils-0.17
 2021-04-29 14:52:38 +09:00
Takeshi KOMIYA
1e1de0713a
Merge pull request #9138 from tk0miya/9137_program_None 
Add doc and testcase for program directive (refs: #9137)
 2021-04-29 02:25:23 +09:00
Takeshi KOMIYA
b821c6c54a
Merge pull request #9139 from oz123/texescape-add-unicode-multiplication 
Add unicode multiplication to texescape
 2021-04-29 02:24:58 +09:00
Oz N Tiram
e8ab9ad260
Add unicode multiplication 
Since checkmark already exists, it makes sense to have this too.
Both signs are used as "yes" or "no" replacements in text UIs.
 2021-04-27 22:46:46 +02:00
Takeshi KOMIYA
d8fa067583 Add doc and testcase for program directive (refs: #9137) 
There is no docs and testcases for "None" argument of the program
directive.  It has been implemented since very old version.  But it's
not documented and tested long.
 2021-04-28 02:16:57 +09:00
Takeshi KOMIYA
25a5b3bf68
Merge pull request #9134 from tk0miya/9094_testcase 
refactor: Add testcase for mathjax3_config (refs: #9094)
 2021-04-27 01:59:56 +09:00
Takeshi KOMIYA
4582d5a396 refactor: Add testcase for mathjax3_config (refs: #9094) 2021-04-25 22:22:13 +09:00
Takeshi KOMIYA
4e9d155396 Merge branch '4.0.x' into 4.x 2021-04-25 21:34:02 +09:00
Takeshi KOMIYA
7e7126a4a8 Merge branch '3.x' into 4.0.x 2021-04-25 21:33:49 +09:00
Takeshi KOMIYA
98e9937b37 Merge branch '3.5.x' into 3.x 2021-04-25 21:33:21 +09:00
Takeshi KOMIYA
09fd75f49f
Merge pull request #9132 from tk0miya/fix_typo 
doc: Fix minor mark-up misses up
 2021-04-24 18:59:24 +09:00
Takeshi KOMIYA
8653ceca00 Update CHANGES for PR #9129 2021-04-24 18:51:17 +09:00
Aaron Carlisle
634b05f3a5 Fix search unnecessarily requiring source files 
This seems to have been a mistake with #4022 the ajax call functions correctly without the source files being included in the build (they are never used).

I have tested this out on several themes and now everything works correctly with `html_copy_source = False`
 2021-04-24 18:44:30 +09:00
Takeshi KOMIYA
cb78512835 doc: Fix minor mark-up misses up 2021-04-24 18:37:30 +09:00
Takeshi KOMIYA
a74b43588e Merge branch '4.0.x' into 4.x 2021-04-24 18:31:11 +09:00
Matthias Geier
778faffecc Add documentation for mathjax2_config and mathjax3_config 2021-04-24 18:30:44 +09:00
Matthias Geier
fde1f417c8 Add CHANGES entry 2021-04-24 18:30:37 +09:00
Matthias Geier
529fb1d1ce Add mathjax3_config config option 2021-04-24 18:30:32 +09:00
Takeshi KOMIYA
2ef86c903c
Merge pull request #9094 from mgeier/mathjax3_config 
Add `mathjax3_config` config option
 2021-04-24 18:27:34 +09:00
Matthias Geier
7b9cc0563d Add documentation for mathjax2_config and mathjax3_config 2021-04-24 10:50:37 +02:00
Matthias Geier
534a2a648b Add CHANGES entry 2021-04-24 10:50:37 +02:00