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,763 Commits 2 Branches 219 Tags
0ee0d8df00956cd07205207c5c1253c161687ba8
Commit Graph

616 Commits

Author SHA1 Message Date
Takeshi KOMIYA
0ee0d8df00 Merge pull request #9399 from tk0miya/napoleon_preprocess_types 
doc: Fix the default value of napoleon_preprocess_types is True
 2021-07-04 11:26:43 +09:00
Takeshi KOMIYA
e8ba4f1803 Merge pull request #9392 from LouisJustinTALLOT/patch-1 
Fix quotes in docstring in ext.napoleon
 2021-07-03 20:10:55 +09:00
Takeshi KOMIYA
f6b3f36e23 doc: Fix the default value of napoleon_preprocess_types is True 2021-07-03 17:41:57 +09:00
Louis-Justin TALLOT
a52ccdbfc7 Fix quotes in docstring in ext.napoleon 2021-06-30 19:40:35 +02:00
Takeshi KOMIYA
ec351bdf3d Merge branch '4.0.x' into 4.x 2021-06-30 21:24:06 +09:00
Jakob Lykke Andersen
50f5280603 C, keyword changes 
- Add new keywords from C23.
- Add c_extra_keywords as confval.
- Move macro names from keywords to c_extra_keywords.

Fixes sphinx-doc/sphinx#9354
 2021-06-17 08:29:39 +02:00
Juan Luis Cano Rodríguez
1ffbfa72f1 Merge branch '4.x' into new-tutorial 2021-06-06 10:49:07 +02:00
Takeshi KOMIYA
e0500f7354 doc: Fix docslint misunderstanding scope of code-blocks 2021-06-06 13:24:06 +09:00
Juan Luis Cano Rodríguez
565713d228 Change Pygments lexer to account for prompt 2021-05-31 18:03:04 +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
Juan Luis Cano Rodríguez
bfca913f16 Move virtual environment explanation to installation 2021-05-29 19:15:15 +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
Takeshi KOMIYA
4d061f2b49 Fix #9252: doc: Update explanation of highlight_language 2021-05-20 02:07:01 +09:00
Takeshi KOMIYA
549f09e048 Merge pull request #9239 from igo95862/https-links 
Upgrade URLs to use HTTPS
 2021-05-19 22:59:19 +09:00
igo95862
0f4039ab56 doc: Fixed opensearch.org link and upgraded to HTTPS 2021-05-17 20:39:14 +03:00
igo95862
82f37344b0 doc: Upgraded dublincore.org link to HTTPS 2021-05-17 20:39:14 +03:00
igo95862
cb004cc046 doc: Upgrade example.com links to HTTPS 2021-05-17 20:39:14 +03:00
igo95862
3f0a840c54 doc: Upgraded plantuml.org link to HTTPS 2021-05-17 20:39:14 +03:00
igo95862
b6c2edb5ca doc: Upgraded mathjax documentation link to HTTPS 2021-05-17 20:39:14 +03:00
igo95862
bb173a5789 doc: Moved flask links to new home and HTTPS 
Seems like Flask is no longer pocoo project but
palletsprojects.com
 2021-05-17 20:39:13 +03:00
igo95862
cfa449624d doc: Moved Jinja links to new home page and HTTPS 
Seems like Jinja is no longer pocoo project but
palletsprojects.com
 2021-05-17 20:38:48 +03:00
Takeshi KOMIYA
bc7087a1a2 Merge branch '4.x' into 3014_autodoc-process-bases 2021-05-17 22:40:27 +09:00
igo95862
29aaf20a11 doc: Upgraded some of sphinx-doc.org links to HTTPS 
Seems like that link is used in some tests and code so
upgrading it outside documentation might break something
 2021-05-16 16:37:36 +03:00
igo95862
6c5f77c689 doc: Upgrade pygments.org links to HTTPS 2021-05-16 15:53:58 +03:00
igo95862
e67c9e5df1 doc: Upgrade docutils.sourceforge.io links to HTTPS 
Also change any docutils.sourceforge.net link to io
top level domain.
 2021-05-16 15:53:49 +03:00
igo95862
28b9475019 doc: Upgrade writethedocs.org domain link to HTTPS 2021-05-16 15:08:18 +03:00
Takeshi KOMIYA
630e5bd15f manpage: Stop creating a section directory on build manpage by default 2021-05-16 17:06:58 +09:00
Takeshi KOMIYA
8d87dde43b Merge pull request #9232 from tk0miya/9217_dont_make_section_directory 
manpage: Stop creating a section directory on build manpage by default
 2021-05-16 17:02:41 +09:00
Takeshi KOMIYA
51ae283a38 Close #4257: autodoc: Add autodoc_class_signature 
Add `autodoc_class_signature` to separate the class entry and the
definition of `__init__()` method.
 2021-05-16 01:53:48 +09:00
Takeshi KOMIYA
67db20d705 Close #3014: autodoc: Add autodoc-process-bases 
Add `autodoc-process-bases` to modify the base classes of the class
definitions.  This allows the extensions to insert or modify the list
of the base classes via event-handlers.
 2021-05-16 00:46:06 +09:00
Takeshi KOMIYA
fa8117cd2f manpage: Stop creating a section directory on build manpage by default 2021-05-15 22:23:40 +09:00
Takeshi KOMIYA
c341807991 Merge pull request #9185 from AWhetter/autodoc_typehints_both 
autodoc.typehints can accurately represent overloads
 2021-05-12 00:23:58 +09:00
Takeshi KOMIYA
0b0414ea17 Update "versionadded" in doc/usage/extensions/autodoc.rst 2021-05-12 00:04:43 +09:00
Ashley Whetter
28d3f8136e autodoc.typehints can accurately represent overloads 2021-05-08 21:34:25 -07:00
Takeshi KOMIYA
ac51fe8d2a doc: Update CHANGES and docs for PR #9176 2021-05-09 02:13:15 +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
ruro
104d0a3f69 describe nitpick_ignore_regex in docs 2021-05-02 13:31:13 +03: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
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
Matthias Geier
778faffecc Add documentation for mathjax2_config and mathjax3_config 2021-04-24 18:30:44 +09:00
Matthias Geier
7b9cc0563d Add documentation for mathjax2_config and mathjax3_config 2021-04-24 10:50:37 +02:00
Takeshi KOMIYA
53dff4ef5f Merge branch '4.0.x' into 4.x 2021-04-20 01:45:12 +09:00
Takeshi KOMIYA
aeb00d8186 doc: Fix typo 2021-04-20 01:13:48 +09:00
Takeshi KOMIYA
668bc9eec9 Merge branch '4.0.x' into 4.x 2021-04-19 01:08:54 +09:00
Harmon
31718d78b4 doc: Fix grammar in documentation for autodoc_typehints 2021-04-17 17:46:31 +02:00
Juan Luis Cano Rodríguez
130ed4bb4a Recommend MyST-Parser for Markdown usage 2021-04-15 20:31:13 +02:00
Harmon
5af55008b3 doc: Fix grammar in documentation for autodoc_typehints 2021-04-14 16:41:25 -05:00
Takeshi KOMIYA
32337c3ba7 Merge pull request #9084 from tk0miya/8731_docs_for_napoleon_preprocess_types 
doc: Add docs for napoleon_preprocess_types
 2021-04-13 01:15:44 +09:00
Takeshi KOMIYA
d59e96c8b4 docs: Add versionchanged tag to extlinks (refs: #8898) 2021-04-11 22:25:48 +09:00
Merry Bass
75605d437f fixup! sphinx.ext.extlinks: Clarify escaping of `%` 2021-04-11 22:14:24 +09:00