summaryrefslogtreecommitdiff
path: root/doc/tutorial
Commit message (Collapse)AuthorAgeFilesLines
* Merge branch '5.x'Jean-François B2022-08-061-1/+1
|\
| * Update deploying.rsteloyvallinaes2022-07-261-1/+1
| | | | | | 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.
* | Note that the tutorial is a tutorial, to help with searchEric Holscher2022-07-211-3/+3
|/
* Update documentation structure and theming (#10677)Chris Holdgraf2022-07-181-3/+3
| | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* Refresh the Sphinx13 theme (#10652)Adam Turner2022-07-101-2/+2
|
* Update GitHub Actions versions (#10561)Adam Turner2022-06-161-2/+2
|
* Replace doclinter with sphinx-lint (#10389)Julien Palard2022-06-161-4/+5
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Merge branch '4.x'Takeshi KOMIYA2022-03-271-4/+3
|\
| * doc: Use :pep: role to refer PEP documentsTakeshi KOMIYA2022-03-271-4/+3
| |
| * Update PEP links in docsHugo van Kemenade2022-03-241-1/+1
| |
* | Fixed typo.Carlton Gibson2022-02-231-1/+1
|/ | | Should read `…an info field list…`, rather than ``…a info field list…`.
* Merge pull request #9852 from astrojuanlu/new-tutorial-deployingTakeshi KOMIYA2021-12-042-0/+280
|\ | | | | New Sphinx tutorial, part IV
| * Remove note to simplify messageJuan Luis Cano Rodríguez2021-11-281-9/+0
| |
| * Add note about `.nojekyll` fileJuan Luis Cano Rodríguez2021-11-231-0/+9
| |
| * Document GitLab PagesJuan Luis Cano Rodríguez2021-11-181-0/+47
| |
| * Add missing content on dependenciesJuan Luis Cano Rodríguez2021-11-181-7/+12
| |
| * Describe deployment on Read the Docs and GitHub PagesJuan Luis Cano Rodríguez2021-11-181-0/+73
| |
| * Write how to publish documentation sourcesJuan Luis Cano Rodríguez2021-11-181-0/+76
| |
| * Change focus to be broader and more descriptiveJuan Luis Cano Rodríguez2021-11-181-5/+2
| |
| * Finish background section on deploymentJuan Luis Cano Rodríguez2021-11-171-0/+24
| |
| * Add descriptive section to deployment section of tutorialJuan Luis Cano Rodríguez2021-11-172-0/+58
| |
* | Merge pull request #9800 from hoefling/extlinks/replacements-checkTakeshi KOMIYA2021-11-291-3/+1
|\ \ | | | | | | Proposal: check if hardcoded URLs can be replaced with extlinks
| * | replace hardcoded refs in docs with extlinksoleg.hoefling2021-11-121-3/+1
| |/ | | | | | | Signed-off-by: oleg.hoefling <oleg.hoefling@gmail.com>
* | Apply suggestions from code reviewJuan Luis Cano Rodríguez2021-11-181-4/+6
| | | | | | Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
* | Remove reference to unmaintained extensionJuan Luis Cano Rodríguez2021-11-151-2/+1
| |
* | TypoJuan Luis Cano Rodríguez2021-11-151-1/+1
| | | | | | Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
* | Add clarification on other languagesJuan Luis Cano Rodríguez2021-11-151-3/+46
|/
* Explain that there are several domainsJuan Luis Cano Rodríguez2021-09-131-0/+7
|
* Get function signature right since the beginningJuan Luis Cano Rodríguez2021-09-132-4/+3
|
* Fix line widthJuan Luis Cano Rodríguez2021-09-131-2/+2
|
* Use stable Sphinx versionJuan Luis Cano Rodríguez2021-09-131-1/+1
|
* Amend explanation on the default-domain directiveJuan Luis Cano Rodríguez2021-09-131-2/+3
|
* Point readers to info field lists insteadJuan Luis Cano Rodríguez2021-09-131-1/+1
|
* Remove square bracketsJuan Luis Cano Rodríguez2021-09-131-4/+2
|
* Improve text of some linksJuan Luis Cano Rodríguez2021-09-132-3/+2
|
* TypoJuan Luis Cano Rodríguez2021-09-131-1/+1
| | | Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
* Insist that automatic is betterJuan Luis Cano Rodríguez2021-09-131-0/+1
|
* Highlight only function docstringJuan Luis Cano Rodríguez2021-09-131-1/+1
| | | Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
* Style improvementsJuan Luis Cano Rodríguez2021-09-131-1/+1
| | | Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
* Add reference to tutorial TOCJuan Luis Cano Rodríguez2021-09-061-3/+3
|
* Add connections to the next sectionsJuan Luis Cano Rodríguez2021-09-065-1/+13
|
* Simplify installationJuan Luis Cano Rodríguez2021-09-062-61/+15
|
* Include explanation about doctestsJuan Luis Cano Rodríguez2021-09-061-0/+5
|
* Simplify doctest sectionJuan Luis Cano Rodríguez2021-09-061-59/+7
|
* Be more explicit on automatic xref generationJuan Luis Cano Rodríguez2021-09-061-1/+1
| | | Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
* Reword primary domainsJuan Luis Cano Rodríguez2021-09-061-3/+6
|
* Rephrase explanation on square bracketsJuan Luis Cano Rodríguez2021-09-061-2/+2
|
* Style improvementJuan Luis Cano Rodríguez2021-09-061-1/+1
| | | Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
* Add section on autosummaryJuan Luis Cano Rodríguez2021-08-121-0/+78
|
* Add section on automatic documentation generationJuan Luis Cano Rodríguez2021-08-123-0/+91
|