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

3177 Commits

Author SHA1 Message Date
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
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
Juan Luis Cano Rodríguez
70ee9bcd6a Tutorial link in front page, audience, objectives, and prerequisites 2021-05-26 21:25:38 +02: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
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
7554ad9593
doc: Upgraded babel.pocoo.org links to HTTPS 2021-05-16 16:37:51 +03: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
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
5078069eb1 Deprecate app.html_themes 
The register is much better to store the HTML themes instead of the
application object.  So this migrates it to the registry object.
 2021-05-12 01:36:14 +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
Dmitry Shachnev
356f7c53e2 Fix typos in doc/extdev/deprecated.rst 2021-05-09 20:14:38 +03: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
Takeshi KOMIYA
30efa3d947
Merge branch '4.x' into 8597_metadata_only_docstring 2021-05-03 22:11:10 +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
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
Takeshi KOMIYA
4e9d155396 Merge branch '4.0.x' into 4.x 2021-04-25 21:34:02 +09:00
Takeshi KOMIYA
cb78512835 doc: Fix minor mark-up misses up 2021-04-24 18:37:30 +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
ff02add8ef
Merge pull request #9101 from V0lantis/fix/fix_user_selection 
Fix `user-selection` in Safari and Internet Explorer
 2021-04-20 01:10:15 +09:00