Commit Graph

3197 Commits

Author SHA1 Message Date
jfbu
35f37a5d03 Same Unicode char replaced 2021-06-14 22:48:04 +02:00
Juan Luis Cano Rodríguez
d92c111ffb Fix whitespace in definition list 2021-06-14 22:45:54 +02:00
Juan Luis Cano Rodríguez
d65acfc1cc Fix another accidental reflow 2021-06-14 22:45:12 +02:00
Juan Luis Cano Rodríguez
ce0f165bae Fix more accidental rewrap 2021-06-14 21:39:25 +02:00
Juan Luis Cano Rodríguez
95e49a1c83 Replace non-ASCII character 2021-06-14 19:14:08 +02:00
Juan Luis Cano Rodríguez
956d311809 Fix accidental rewrap 2021-06-14 19:07:25 +02:00
Juan Luis Cano Rodríguez
aee105ce46 Rewrap text 2021-06-06 17:19:39 +02:00
Juan Luis Cano Rodríguez
a2a8a07430 Adjust line length 2021-06-06 10:56:23 +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
b6245266ab
Merge pull request #9303 from tk0miya/fix_docslint
doc: Fix docslint misunderstanding scope of code-blocks
2021-06-06 13:33:17 +09:00
Takeshi KOMIYA
e0500f7354 doc: Fix docslint misunderstanding scope of code-blocks 2021-06-06 13:24:06 +09:00
Takeshi KOMIYA
1418e3acbb
Merge pull request #9260 from tk0miya/9016_linkcheck_github_anchors
Close #9016: linkcheck builder failed to check the anchors of github.com
2021-06-04 01:18:22 +09:00
Juan Luis Cano Rodríguez
565713d228 Change Pygments lexer to account for prompt 2021-05-31 18:03:04 +02:00
Takeshi KOMIYA
92335bd6e6 Close #9016: linkcheck builder failed to check the anchors of github.com 2021-06-01 00:31:15 +09:00
Juan Luis Cano Rodríguez
ce727e3cfe More style changes 2021-05-31 16:35:35 +02:00
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
46c2e45aa6 deprecate sphinx.ext.autosummary._app 2021-05-31 02:09:10 +09: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
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
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