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

Update README to add basic installation and usage patterns #97

Merged
merged 4 commits into from
Mar 13, 2024
Merged

Update README to add basic installation and usage patterns #97

merged 4 commits into from
Mar 13, 2024

Commits on Mar 13, 2024

  1. Add basic usage pattern to README 

    See JoFrhwld#96
    @chrisbrickhouse
    chrisbrickhouse committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    64c7ab5 View commit details
    Browse the repository at this point in the history

  2. Fix MFA link

    @chrisbrickhouse
    chrisbrickhouse committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    ea7f999 View commit details
    Browse the repository at this point in the history

  3. Bump sphinx to v5 to fix build failure

    @chrisbrickhouse
    chrisbrickhouse committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    91fdb95 View commit details
    Browse the repository at this point in the history

  4. Update workflow to use Sphinx 7 

    The builds were failing because the sphinx-action used by our workflow
defaulted to Sphinx 2.2.0 regardless of what was in the pyproject.toml
The current solution according to ammaraskar/sphinx-action#56 is to use
a tag corresponding to the sphinx version you want to use.
    @chrisbrickhouse
    chrisbrickhouse committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    f07209b View commit details
    Browse the repository at this point in the history