Chris Sewell
8f97fd276a
[docs] Improve landing page ( #12453 )
...
This commit is intended to improve new user's first-interaction with the Sphinx site:
- Make page header icon/text smaller and not capitalized
- Give min-width to left sidebar (it was getting too small at certain window sizes)
- Replace features list on landing page with admonition boxes, with adaptive layout
- Add landing page "used by" section
- Slightly restructure the Extension section, into Tutorials and How-tos
- Add code to `conf.py` to write HTML write redirect pages for moved documents
- Improve support page, by adding link to Stackoverflow, GH discussion and ReadtheDocs,
and remove defunct link to libera chat and matplotlib tutorial
2024-06-21 20:12:57 +02:00
Eric Holscher
7a9f22d661
Note that the tutorial is a tutorial, to help with search
2022-07-21 15:12:18 -07:00
Chris Holdgraf
eb0a6c574f
Update documentation structure and theming ( #10677 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2022-07-18 22:48:28 +01:00
Juan Luis Cano Rodríguez
ad36d86d2c
Add descriptive section to deployment section of tutorial
2021-11-17 21:36:48 +01: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
2c1fa831c1
Add tutorial section on documenting Python objects
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
