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.

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

Replace sphinx napoleon for numpydoc #195

Merged
merged 9 commits into from
Oct 15, 2024
Merged

Replace sphinx napoleon for numpydoc #195

merged 9 commits into from
Oct 15, 2024

Commits on Apr 25, 2024

  1. Configuration menu
    Copy the full SHA
    89ba04b View commit details
    Browse the repository at this point in the history
  2. Update Sphinx templates for classes

    Remove the list of methods and attributes from the template since
    numpydoc builds its own lists for them.
    santisoler committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    1144552 View commit details
    Browse the repository at this point in the history
  3. Include caution admonitions in Notes section

    Put the admonitions in the Notes section to make numpydoc to render it
    properly.
    santisoler committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    f045fe6 View commit details
    Browse the repository at this point in the history
  4. Run black

    santisoler committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    dde55be View commit details
    Browse the repository at this point in the history

Commits on May 10, 2024

  1. Restore attributes to the class template

    Include the attributes to the class template so we can still show
    detailed descriptions for them, including math and their units.
    The attribute list that numpydoc generate has links to the corresponding
    description of the attributes.
    santisoler committed May 10, 2024
    Configuration menu
    Copy the full SHA
    62b0e7c View commit details
    Browse the repository at this point in the history
  2. Show attributes like the parameters section

    Configure numpydoc to show the list of attributes as the parameters
    section.
    santisoler committed May 10, 2024
    Configuration menu
    Copy the full SHA
    f41c13c View commit details
    Browse the repository at this point in the history

Commits on Jun 7, 2024

  1. Configuration menu
    Copy the full SHA
    2d04861 View commit details
    Browse the repository at this point in the history

Commits on Oct 8, 2024

  1. Configuration menu
    Copy the full SHA
    a9e726d View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    e812967 View commit details
    Browse the repository at this point in the history