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

Basic mkdocs documentation setup #75

Merged
merged 12 commits into from
May 28, 2022
Merged

Basic mkdocs documentation setup #75

merged 12 commits into from
May 28, 2022

Commits on May 27, 2022

  1. Add preliminary docs setup

    @rlskoeser
    rlskoeser committed May 27, 2022
    Configuration menu
    Copy the full SHA
    53ceca6 View commit details
    Browse the repository at this point in the history

  2. Fix dev requirements path and doc deps install

    @rlskoeser
    rlskoeser committed May 27, 2022
    Configuration menu
    Copy the full SHA
    911e686 View commit details
    Browse the repository at this point in the history

  3. Build docs in strict mode to check pull requests

    @rlskoeser
    rlskoeser committed May 27, 2022
    Configuration menu
    Copy the full SHA
    0255195 View commit details
    Browse the repository at this point in the history

  4. Require newer version of mkdocstrings

    @rlskoeser
    rlskoeser committed May 27, 2022
    Configuration menu
    Copy the full SHA
    66b9726 View commit details
    Browse the repository at this point in the history

  5. Rename docs workflow

    @rlskoeser
    rlskoeser committed May 27, 2022
    Configuration menu
    Copy the full SHA
    7cd1771 View commit details
    Browse the repository at this point in the history

  6. Specify path for pip cache file

    @rlskoeser
    rlskoeser committed May 27, 2022
    Configuration menu
    Copy the full SHA
    4aa2799 View commit details
    Browse the repository at this point in the history

  7. Rename docs workflow job 

    (build & deploy or build to check)
    @rlskoeser
    rlskoeser committed May 27, 2022
    Configuration menu
    Copy the full SHA
    4e9941a View commit details
    Browse the repository at this point in the history

  8. Make link in readme absolute so it works in docs

    @rlskoeser
    rlskoeser committed May 27, 2022
    Configuration menu
    Copy the full SHA
    b5724da View commit details
    Browse the repository at this point in the history

  9. Add readme to docs nav

    @rlskoeser
    rlskoeser committed May 27, 2022
    Configuration menu
    Copy the full SHA
    20de734 View commit details
    Browse the repository at this point in the history

  10. Move docstring to the method it describes

    @rlskoeser
    rlskoeser committed May 27, 2022
    Configuration menu
    Copy the full SHA
    f824bf0 View commit details
    Browse the repository at this point in the history

  11. Merge branch 'main' into setup-docs

    @rlskoeser
    rlskoeser committed May 27, 2022
    Configuration menu
    Copy the full SHA
    ba3d140 View commit details
    Browse the repository at this point in the history

  12. Correct docstring for no return

    @rlskoeser
    rlskoeser committed May 27, 2022
    Configuration menu
    Copy the full SHA
    4d66f15 View commit details
    Browse the repository at this point in the history