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

Make documentation/docstrings testable #1035

Merged
merged 15 commits into from
Jun 7, 2022
Merged

Make documentation/docstrings testable #1035

merged 15 commits into from
Jun 7, 2022

Commits on May 31, 2022

  1. Enable doctest in sphinx

    @eleftherioszisis
    eleftherioszisis authored and Eleftherios Zisis committed May 31, 2022
    Configuration menu
    Copy the full SHA
    ae46fd8 View commit details
    Browse the repository at this point in the history

  2. Fix modules to pass with doctest

    @eleftherioszisis
    eleftherioszisis authored and Eleftherios Zisis committed May 31, 2022
    Configuration menu
    Copy the full SHA
    ab199b9 View commit details
    Browse the repository at this point in the history

  3. Fix docstrings snippets

    @eleftherioszisis
    eleftherioszisis authored and Eleftherios Zisis committed May 31, 2022
    Configuration menu
    Copy the full SHA
    febc294 View commit details
    Browse the repository at this point in the history

  4. update documentation

    @eleftherioszisis
    eleftherioszisis authored and Eleftherios Zisis committed May 31, 2022
    Configuration menu
    Copy the full SHA
    41567fe View commit details
    Browse the repository at this point in the history

  5. Add sphinx doctest to testenv

    @eleftherioszisis
    eleftherioszisis authored and Eleftherios Zisis committed May 31, 2022
    Configuration menu
    Copy the full SHA
    0b24dc2 View commit details
    Browse the repository at this point in the history

  6. Convert code snippets into testable code

    @eleftherioszisis
    eleftherioszisis authored and Eleftherios Zisis committed May 31, 2022
    Configuration menu
    Copy the full SHA
    9862d32 View commit details
    Browse the repository at this point in the history

  7. Remove deprecated viewer code from documentation

    @eleftherioszisis
    eleftherioszisis authored and Eleftherios Zisis committed May 31, 2022
    Configuration menu
    Copy the full SHA
    cf8a9e0 View commit details
    Browse the repository at this point in the history

  8. Use only paths

    @eleftherioszisis
    eleftherioszisis authored and Eleftherios Zisis committed May 31, 2022
    Configuration menu
    Copy the full SHA
    879f914 View commit details
    Browse the repository at this point in the history

  9. Comment out stuff

    @eleftherioszisis
    eleftherioszisis authored and Eleftherios Zisis committed May 31, 2022
    Configuration menu
    Copy the full SHA
    c1b6cac View commit details
    Browse the repository at this point in the history

  10. Use sphinx-build cli

    @eleftherioszisis
    eleftherioszisis authored and Eleftherios Zisis committed May 31, 2022
    Configuration menu
    Copy the full SHA
    97e0f28 View commit details
    Browse the repository at this point in the history

  11. Remove changedir

    @eleftherioszisis
    eleftherioszisis authored and Eleftherios Zisis committed May 31, 2022
    Configuration menu
    Copy the full SHA
    7deb84e View commit details
    Browse the repository at this point in the history

  12. Remove sphinx dep

    Eleftherios Zisis committed May 31, 2022
    Configuration menu
    Copy the full SHA
    b5cda23 View commit details
    Browse the repository at this point in the history

Commits on Jun 6, 2022

  1. Update doc/source/developer.rst 

    Co-authored-by: Adrien Berchet <adrien.berchet@gmail.com>
    @eleftherioszisis @adrien-berchet
    eleftherioszisis and adrien-berchet committed Jun 6, 2022
    Configuration menu
    Copy the full SHA
    05300a9 View commit details
    Browse the repository at this point in the history

  2. Update doc/source/examples.rst 

    Co-authored-by: Adrien Berchet <adrien.berchet@gmail.com>
    @eleftherioszisis @adrien-berchet
    eleftherioszisis and adrien-berchet committed Jun 6, 2022
    Configuration menu
    Copy the full SHA
    3641e54 View commit details
    Browse the repository at this point in the history

  3. Update doc/source/examples.rst 

    Co-authored-by: Adrien Berchet <adrien.berchet@gmail.com>
    @eleftherioszisis @adrien-berchet
    eleftherioszisis and adrien-berchet committed Jun 6, 2022
    Configuration menu
    Copy the full SHA
    9765136 View commit details
    Browse the repository at this point in the history