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,839 Commits 2 Branches 219 Tags
b20e04968e73234da9fff7d19b12dfbeebebe944
Commit Graph

3417 Commits

Author SHA1 Message Date
Juan Luis Cano Rodríguez
dc5dc61e3f Turn plain image into figure 2021-06-16 19:49:37 +02:00
Juan Luis Cano Rodríguez
167828fde9 Add section about exporting to other formats 2021-06-16 19:49:37 +02:00
Juan Luis Cano Rodríguez
1cbaf7ff30 Minor style fixes 2021-06-16 19:49:37 +02:00
Juan Luis Cano Rodríguez
5e7c011b92 Fix broken link to third-party extensions 2021-06-16 18:32:02 +02:00
Jean-François B
e0b1e1002b Merge pull request #9332 from jfbu/latex_doc_9321_utf8x 
Closes: #9321 (LaTeX utf8x usage doc)
 2021-06-16 17:25:03 +02:00
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
ocket8888
9db8775ba7 Update example to use recommended usage 2021-06-14 11:21:28 -06: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
Takeshi KOMIYA
62f128700e Fix #9032: docs: sphinx.environment.NoUri was removed at v3.0.0 
Our deprecation list describes `sphinx.environment.NoUri` was removed at
v4.0.0.  But, acutally, it was removed at v3.0.0 (#6223).
 2021-06-14 02:18:01 +09:00
jfbu
9dbf2c9a98 Closes: #9321 (LaTeX utf8x usage doc) 2021-06-13 12:29:39 +02:00
Takeshi KOMIYA
519cc078fd Revert the removal of sphinx.util:force_decode() 
After the release of 4.0.0, some 3rd party extensions have became not
working with the latest Sphinx because `force_decode()` function was
removed.  It was deprecated since Sphinx-2.0 and warned for the removal
since 3.0.

This reverts the removal and extends its deprecation period to 5.0.0.  I
hope it helps users of these extensions.
 2021-06-13 16:31:33 +09: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
Sorin Sbarnea
82d769c56e Document new irc channel location 2021-06-01 11:09:19 +01: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
988a79de65 linkcheck: Emit a warning for disallowed redirects 
Now linkcheck builder integrates `linkcheck_warn_redirects` into
`linkcheck_allowed_redirects`.  As a result, linkcheck builder will
emit a warning when "disallowed" redirection detected via
`linkcheck_allowed_redirects`.
 2021-05-31 21:53:09 +09:00
Takeshi KOMIYA
2887dd07df doc: Fix indentation 2021-05-31 02:59:35 +09:00
Takeshi KOMIYA
48c80b17b4 doc: Fix indentation 2021-05-31 02:58:29 +09:00
Takeshi KOMIYA
676834b998 Merge branch '4.x' into 6525_linkcheck_warn_redirects 2021-05-31 02:54:41 +09:00
Takeshi KOMIYA
fe89a07a92 Fix typo in doc/usage/configuration.rst 
Co-authored-by: François Freitag <mail@franek.fr>
 2021-05-31 02:54:17 +09: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
c97e9b14c4 Update docs 2021-05-20 23:43:34 +09:00
Takeshi KOMIYA
ce9e2e6c74 Rename linkcheck_ignore_redirects to linkcheck_allowed_redirects 2021-05-20 23:26:16 +09:00
Takeshi KOMIYA
4d061f2b49 Fix #9252: doc: Update explanation of highlight_language 2021-05-20 02:07:01 +09:00