Adam Turner
801c60a873
Consistently calculate the current file's directory
2024-11-03 17:28:02 +00:00
Tim Hoffmann
b2d69a7f41
Make a dedicated section for cross-reference syntax in docs ( #12984 )
2024-10-07 20:14:41 +01:00
Adam Turner
9e3f4521db
Drop support for Python 3.9 ( #12633 )
2024-07-22 15:05:15 +01:00
Adam Turner
f2640a4286
Standardise on "reStructuredText" over "reST" in documentation
2024-07-15 02:15:52 +01:00
Adam Turner
26576590ed
Make the domain referencing role targets more specific
2024-07-15 01:59:42 +01:00
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
Nicolas Peugnet
90574bc966
[patch] fix undefined label after readthedocs update ( #12395 )
2024-05-29 12:32:26 +02:00
Bénédikt Tran
f44ff30673
[doc] cleanup references and update external URLs ( #12182 )
2024-03-25 11:39:05 +01:00
Adam Turner
23cef9b59a
Use `https://` where possible
2024-01-14 04:18:57 +00:00
Adam Turner
cb9656f654
Update all GitHub Actions versions
2024-01-03 03:31:39 +00:00
Rex Yuan
23c9cb4e78
[docs] Fix Makefile target in describing-code.rst ( #11428 )
2023-12-30 14:48:16 +01:00
Adam Turner
385a9193a7
Remove redundant labels
2023-10-02 13:10:26 +01:00
Adam Turner
c0e17eca40
Move the domains reference up one level
2023-10-02 13:09:38 +01:00
Adam Turner
b935915c57
Improve make-mode documentation ( #11692 )
2023-09-21 09:39:39 +01:00
Adam Turner
9298de548f
Update CI configuration
...
- Merge LaTeX and Coverage into the main CI file
- Only run tests when a relevant file changes
- Update ``actions/checkout``
- Set ``-Werror`` only on pytest steps
- Reduce verbosity on the documentation workflow
2023-09-21 09:08:29 +01:00
Adam Turner
db739afaeb
Update permissions in the tutorial deployment workflow
2023-08-12 06:42:33 +01:00
Jean-François B
5c82449eca
Merge branch '5.x'
2022-08-06 18:31:14 +02:00
eloyvallinaes
2800db0b70
Update deploying.rst
...
Version 0.4 of sphinx-action contains a problem investigated and documented here: https://github.com/ammaraskar/sphinx-action/issues/5 . The action throws an error claiming it can't write the log file. The problem is fixed in master and since this is a tutorial, it is more or less expected that it should work off the bat, so I thinking pinning the master version for now and the next release when it comes out, might be the best way to help newbies.
2022-07-26 11:17:53 +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
Adam Turner
9112cfeb8d
Refresh the Sphinx13 theme ( #10652 )
2022-07-10 22:48:15 +01:00
Adam Turner
6ab15a047c
Update GitHub Actions versions ( #10561 )
2022-06-16 21:43:00 +01:00
Julien Palard
956cddb7d4
Replace doclinter with sphinx-lint ( #10389 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-06-16 19:32:09 +01:00
Takeshi KOMIYA
2db180da70
Merge branch '4.x'
2022-03-27 19:47:11 +09:00
Takeshi KOMIYA
fbdfade068
doc: Use :pep: role to refer PEP documents
2022-03-27 01:46:22 +09:00
Hugo van Kemenade
a432bf8c10
Update PEP links in docs
2022-03-24 12:34:05 +02:00
Carlton Gibson
3de086fb35
Fixed typo.
...
Should read `…an info field list…`, rather than ``…a info field list…`.
2022-02-23 20:29:50 +01:00
Takeshi KOMIYA
86639b7be9
Merge pull request #9852 from astrojuanlu/new-tutorial-deploying
...
New Sphinx tutorial, part IV
2021-12-04 12:02:23 +09:00
Takeshi KOMIYA
74d912133a
Merge pull request #9800 from hoefling/extlinks/replacements-check
...
Proposal: check if hardcoded URLs can be replaced with extlinks
2021-11-29 09:36:55 +09:00
Juan Luis Cano Rodríguez
f6a3d037f4
Remove note to simplify message
2021-11-28 19:58:30 +01:00
Juan Luis Cano Rodríguez
d39c6861d9
Add note about .nojekyll file
2021-11-23 10:17:09 +01:00
Juan Luis Cano Rodríguez
79f6d40413
Apply suggestions from code review
...
Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
2021-11-18 23:04:30 +01:00
Juan Luis Cano Rodríguez
daceb8aba3
Document GitLab Pages
2021-11-18 19:34:09 +01:00
Juan Luis Cano Rodríguez
043b5e9253
Add missing content on dependencies
2021-11-18 18:47:39 +01:00
Juan Luis Cano Rodríguez
1d1b2296c5
Describe deployment on Read the Docs and GitHub Pages
2021-11-18 15:58:53 +01:00
Juan Luis Cano Rodríguez
142c5cf853
Write how to publish documentation sources
2021-11-18 10:35:28 +01:00
Juan Luis Cano Rodríguez
7045505eaf
Change focus to be broader and more descriptive
2021-11-18 10:19:14 +01:00
Juan Luis Cano Rodríguez
f16f4a249b
Finish background section on deployment
2021-11-17 21:37:01 +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
eceb6b8f4b
Remove reference to unmaintained extension
2021-11-15 14:30:07 +01:00
Juan Luis Cano Rodríguez
d7d82a88ad
Typo
...
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
2021-11-15 14:29:17 +01:00
Juan Luis Cano Rodríguez
34c165e497
Add clarification on other languages
2021-11-15 12:46:03 +01:00
oleg.hoefling
629145a0e8
replace hardcoded refs in docs with extlinks
...
Signed-off-by: oleg.hoefling <oleg.hoefling@gmail.com>
2021-11-12 09:41:34 +01:00
Juan Luis Cano Rodríguez
4920e4e5dc
Explain that there are several domains
2021-09-13 15:48:47 +02:00
Juan Luis Cano Rodríguez
ae3eab278c
Get function signature right since the beginning
2021-09-13 15:33:37 +02:00
Juan Luis Cano Rodríguez
02119aba8d
Fix line width
2021-09-13 15:29:25 +02:00
Juan Luis Cano Rodríguez
9a8d7aef2f
Use stable Sphinx version
2021-09-13 15:28:17 +02:00
Juan Luis Cano Rodríguez
ccc95ea626
Amend explanation on the default-domain directive
2021-09-13 15:24:36 +02:00
Juan Luis Cano Rodríguez
1677f416bc
Point readers to info field lists instead
2021-09-13 15:23:19 +02:00
Juan Luis Cano Rodríguez
87b8a0b211
Remove square brackets
2021-09-13 15:17:14 +02:00
