Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New Sphinx tutorial, part III #9534

Merged
merged 27 commits into from Oct 9, 2021
Merged

New Sphinx tutorial, part III #9534

merged 27 commits into from Oct 9, 2021

Commits on Aug 12, 2021

  1. Add cross reference to role definitions

    @astrojuanlu
    astrojuanlu committed Aug 12, 2021
    Configuration menu
    Copy the full SHA
    1a1e45f View commit details
    Browse the repository at this point in the history

  2. Add tutorial section on documenting Python objects

    @astrojuanlu
    astrojuanlu committed Aug 12, 2021
    Configuration menu
    Copy the full SHA
    2c1fa83 View commit details
    Browse the repository at this point in the history

  3. Add section on Python code preparation

    @astrojuanlu
    astrojuanlu committed Aug 12, 2021
    Configuration menu
    Copy the full SHA
    a5c6845 View commit details
    Browse the repository at this point in the history

  4. Add section on doctests

    @astrojuanlu
    astrojuanlu committed Aug 12, 2021
    Configuration menu
    Copy the full SHA
    8334fd9 View commit details
    Browse the repository at this point in the history

  5. Add section on automatic documentation generation

    @astrojuanlu
    astrojuanlu committed Aug 12, 2021
    Configuration menu
    Copy the full SHA
    8573c28 View commit details
    Browse the repository at this point in the history

  6. Add section on autosummary

    @astrojuanlu
    astrojuanlu committed Aug 12, 2021
    Configuration menu
    Copy the full SHA
    a606db0 View commit details
    Browse the repository at this point in the history

Commits on Sep 6, 2021

  1. Style improvement 

    Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
    @astrojuanlu @ericholscher
    astrojuanlu and ericholscher committed Sep 6, 2021
    Configuration menu
    Copy the full SHA
    c721d17 View commit details
    Browse the repository at this point in the history

  2. Rephrase explanation on square brackets

    @astrojuanlu
    astrojuanlu committed Sep 6, 2021
    Configuration menu
    Copy the full SHA
    722629b View commit details
    Browse the repository at this point in the history

  3. Reword primary domains

    @astrojuanlu
    astrojuanlu committed Sep 6, 2021
    Configuration menu
    Copy the full SHA
    da93cfc View commit details
    Browse the repository at this point in the history

  4. Be more explicit on automatic xref generation 

    Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
    @astrojuanlu @ericholscher
    astrojuanlu and ericholscher committed Sep 6, 2021
    Configuration menu
    Copy the full SHA
    d505635 View commit details
    Browse the repository at this point in the history

  5. Simplify doctest section

    @astrojuanlu
    astrojuanlu committed Sep 6, 2021
    Configuration menu
    Copy the full SHA
    878478e View commit details
    Browse the repository at this point in the history

  6. Include explanation about doctests

    @astrojuanlu
    astrojuanlu committed Sep 6, 2021
    Configuration menu
    Copy the full SHA
    70bc61f View commit details
    Browse the repository at this point in the history

  7. Simplify installation

    @astrojuanlu
    astrojuanlu committed Sep 6, 2021
    Configuration menu
    Copy the full SHA
    32f2f90 View commit details
    Browse the repository at this point in the history

  8. Add connections to the next sections

    @astrojuanlu
    astrojuanlu committed Sep 6, 2021
    Configuration menu
    Copy the full SHA
    2755333 View commit details
    Browse the repository at this point in the history

  9. Add reference to tutorial TOC

    @astrojuanlu
    astrojuanlu committed Sep 6, 2021
    Configuration menu
    Copy the full SHA
    53104ca View commit details
    Browse the repository at this point in the history

Commits on Sep 13, 2021

  1. Style improvements 

    Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
    @astrojuanlu @humitos
    astrojuanlu and humitos committed Sep 13, 2021
    Configuration menu
    Copy the full SHA
    5daf336 View commit details
    Browse the repository at this point in the history

  2. Highlight only function docstring 

    Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
    @astrojuanlu @humitos
    astrojuanlu and humitos committed Sep 13, 2021
    Configuration menu
    Copy the full SHA
    91a605c View commit details
    Browse the repository at this point in the history

  3. Insist that automatic is better

    @astrojuanlu
    astrojuanlu committed Sep 13, 2021
    Configuration menu
    Copy the full SHA
    d7e525b View commit details
    Browse the repository at this point in the history

  4. Typo 

    Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
    @astrojuanlu @tk0miya
    astrojuanlu and tk0miya committed Sep 13, 2021
    Configuration menu
    Copy the full SHA
    9aa9d0e View commit details
    Browse the repository at this point in the history

  5. Improve text of some links

    @astrojuanlu
    astrojuanlu committed Sep 13, 2021
    Configuration menu
    Copy the full SHA
    c2847c2 View commit details
    Browse the repository at this point in the history

  6. Remove square brackets

    @astrojuanlu
    astrojuanlu committed Sep 13, 2021
    Configuration menu
    Copy the full SHA
    87b8a0b View commit details
    Browse the repository at this point in the history

  7. Point readers to info field lists instead

    @astrojuanlu
    astrojuanlu committed Sep 13, 2021
    Configuration menu
    Copy the full SHA
    1677f41 View commit details
    Browse the repository at this point in the history

  8. Amend explanation on the default-domain directive

    @astrojuanlu
    astrojuanlu committed Sep 13, 2021
    Configuration menu
    Copy the full SHA
    ccc95ea View commit details
    Browse the repository at this point in the history

  9. Use stable Sphinx version

    @astrojuanlu
    astrojuanlu committed Sep 13, 2021
    Configuration menu
    Copy the full SHA
    9a8d7ae View commit details
    Browse the repository at this point in the history

  10. Fix line width

    @astrojuanlu
    astrojuanlu committed Sep 13, 2021
    Configuration menu
    Copy the full SHA
    02119ab View commit details
    Browse the repository at this point in the history

  11. Get function signature right since the beginning

    @astrojuanlu
    astrojuanlu committed Sep 13, 2021
    Configuration menu
    Copy the full SHA
    ae3eab2 View commit details
    Browse the repository at this point in the history

  12. Explain that there are several domains

    @astrojuanlu
    astrojuanlu committed Sep 13, 2021
    Configuration menu
    Copy the full SHA
    4920e4e View commit details
    Browse the repository at this point in the history