Commit Graph

22 Commits

Author SHA1 Message Date
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
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
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