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
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
Juan Luis Cano Rodríguez
c2847c2563
Improve text of some links
2021-09-13 15:13:01 +02:00
Juan Luis Cano Rodríguez
9aa9d0e2ad
Typo
...
Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
2021-09-13 15:03:35 +02:00
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
