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
21,304 Commits 2 Branches 219 Tags 163 MiB
be52db2bb3
Commit Graph

122 Commits

Author SHA1 Message Date
Juan Luis Cano Rodríguez
d7e525b9db Insist that automatic is better 2021-09-13 15:00:12 +02:00
Juan Luis Cano Rodríguez
91a605c6f1
Highlight only function docstring 
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
 2021-09-13 14:57:11 +02:00
Juan Luis Cano Rodríguez
5daf336943
Style improvements 
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
 2021-09-13 14:56:31 +02:00
Juan Luis Cano Rodríguez
53104cadc0 Add reference to tutorial TOC 2021-09-06 17:14:31 +02:00
Juan Luis Cano Rodríguez
2755333437 Add connections to the next sections 2021-09-06 17:14:31 +02:00
Juan Luis Cano Rodríguez
32f2f909ac Simplify installation 2021-09-06 17:14:31 +02:00
Juan Luis Cano Rodríguez
70bc61f0f3 Include explanation about doctests 2021-09-06 16:38:18 +02:00
Juan Luis Cano Rodríguez
878478e725 Simplify doctest section 2021-09-06 16:35:00 +02:00
Juan Luis Cano Rodríguez
d505635224
Be more explicit on automatic xref generation 
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
 2021-09-06 16:29:43 +02:00
Juan Luis Cano Rodríguez
da93cfc07f Reword primary domains 2021-09-06 16:26:03 +02:00
Juan Luis Cano Rodríguez
722629b35b Rephrase explanation on square brackets 2021-09-06 14:58:18 +02:00
Juan Luis Cano Rodríguez
c721d1746a
Style improvement 
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
 2021-09-06 14:36:25 +02:00
Juan Luis Cano Rodríguez
a606db01f1 Add section on autosummary 2021-08-12 20:09:50 +02:00
Juan Luis Cano Rodríguez
8573c281ec Add section on automatic documentation generation 2021-08-12 20:09:50 +02:00
Juan Luis Cano Rodríguez
8334fd983e Add section on doctests 2021-08-12 20:09:50 +02:00
Juan Luis Cano Rodríguez
a5c684510e Add section on Python code preparation 2021-08-12 20:06:56 +02:00
Juan Luis Cano Rodríguez
2c1fa831c1 Add tutorial section on documenting Python objects 2021-08-12 20:06:56 +02:00
Juan Luis Cano Rodríguez
1a1e45f1af Add cross reference to role definitions 2021-08-12 20:06:56 +02:00
Juan Luis Cano Rodríguez
f152680bfb Split tutorial in several files 2021-08-11 13:31:47 +02:00
jfbu
e1612b4909 Remove mark-up breaking PDF output 
Close: #9475

Refs: #9355
 2021-07-19 12:23:30 +02:00
Juan Luis Cano Rodríguez
cb846a39e0 Add link to docutils docs 2021-07-05 09:39:14 +02:00
Juan Luis Cano Rodríguez
6f9bc6e7e5 Use "builtin" for extensions label as it is done for themes 2021-07-05 09:32:10 +02:00
Juan Luis Cano Rodríguez
f303a4a9ed Consistent use of "rst" for syntax highlight 2021-07-05 09:25:05 +02:00
Juan Luis Cano Rodríguez
50bd1c3967 Remove unnecessary label 2021-07-05 09:22:14 +02:00
Juan Luis Cano Rodríguez
74e565f99b Consistent use of "build documentation" 2021-07-05 09:21:55 +02:00
Juan Luis Cano Rodríguez
d5f452a81f Remove redundant local table of contents 2021-07-05 09:12:40 +02:00
Juan Luis Cano Rodríguez
013e67f4fd Clarify what happens if no title is used in the :ref: 2021-06-22 15:44:52 +02:00
Juan Luis Cano Rodríguez
15fe52dce6 Separate extensions and themes more clearly 2021-06-22 15:37:30 +02:00
Juan Luis Cano Rodríguez
c9d2a73d93 Rename to root document 2021-06-22 15:27:54 +02:00
Juan Luis Cano Rodríguez
5f41044abb
Tone down LaTeX info to "note" 
Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
 2021-06-22 15:20:06 +02:00
Juan Luis Cano Rodríguez
a3478eb2d0
Update doc/tutorial/index.rst 
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
 2021-06-21 14:25:17 +02:00
Juan Luis Cano Rodríguez
106346a4ef Make section title more goal-oriented 2021-06-21 08:24:10 +02:00
Juan Luis Cano Rodríguez
e865c526bb Add filenames as captions for relevant code blocks 2021-06-21 08:17:30 +02:00
Juan Luis Cano Rodríguez
35714269e8 Add text representation of the document structure 2021-06-21 08:09:26 +02:00
Juan Luis Cano Rodríguez
0581a17ca6 Clarify this is about HTML themes 2021-06-21 08:02:21 +02:00
Juan Luis Cano Rodríguez
8377a550a2 Simplify out-of-toctree warning 2021-06-21 07:46:13 +02:00
Juan Luis Cano Rodríguez
3fcaa172db Move reference to list of Pygments lexers 2021-06-21 07:38:51 +02:00
Juan Luis Cano Rodríguez
d08c3677d1 Avoid reference to earlier content 2021-06-21 07:30:02 +02:00
Juan Luis Cano Rodríguez
e75f31ad47 Add link to third-party sphinx-themes 2021-06-21 07:11:22 +02:00
Juan Luis Cano Rodríguez
6f71c7bd7e Use absolute links for Sphinx documentation references 2021-06-21 07:09:19 +02:00
Juan Luis Cano Rodríguez
fb236053ab Apply style suggestions from code review 
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
 2021-06-21 07:04:44 +02:00
Juan Luis Cano Rodríguez
5a057d3da1 Actually use new theme 2021-06-17 01:01:34 +02:00
Juan Luis Cano Rodríguez
e022872f3b Add section about cross-references 2021-06-17 00:37:32 +02:00
Juan Luis Cano Rodríguez
57b0a1b465 Add section about the toctree 2021-06-17 00:31:53 +02:00
Juan Luis Cano Rodríguez
2058acc4f9 Add local table of contents 2021-06-17 00:21:42 +02:00
Juan Luis Cano Rodríguez
1e49218993 Add tutorial section about extensions and themes 2021-06-17 00:21:42 +02:00
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
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
565713d228 Change Pygments lexer to account for prompt 2021-05-31 18:03:04 +02: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
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