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

WIP: Resolve docstring errors and transition to MkDocs #35

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

WIP: Resolve docstring errors and transition to MkDocs #35

wants to merge 11 commits into from
+827 −260

Commits on Oct 29, 2024

  1. switch pyproject.toml to uv

    @MitchellAcoustics
    MitchellAcoustics committed Oct 29, 2024
    Configuration menu
    Copy the full SHA
    26605b0 View commit details
    Browse the repository at this point in the history

  2. configure readthedocs to use uv 

    Should speed up the readthedocs build. I can't test this configuration since I don't have access to the readthedocs account though.
    @MitchellAcoustics
    MitchellAcoustics committed Oct 29, 2024
    Configuration menu
    Copy the full SHA
    8ed40dd View commit details
    Browse the repository at this point in the history

  3. update GH action to use uv 

    tested locally using [act](https://www.freecodecamp.org/news/how-to-run-github-actions-locally/)
    @MitchellAcoustics
    MitchellAcoustics committed Oct 29, 2024
    Configuration menu
    Copy the full SHA
    4b61d4e View commit details
    Browse the repository at this point in the history

Commits on Oct 30, 2024

  1. readthedocs yaml requires a number, not a string

    @MitchellAcoustics
    MitchellAcoustics committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    82c11ff View commit details
    Browse the repository at this point in the history

  2. setup mkdocs

    @MitchellAcoustics
    MitchellAcoustics committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    4dda549 View commit details
    Browse the repository at this point in the history

  3. enable KaTeX support

    @MitchellAcoustics
    MitchellAcoustics committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    2b75b9c View commit details
    Browse the repository at this point in the history

  4. mkdocs formatting setup

    @MitchellAcoustics
    MitchellAcoustics committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    d7d4886 View commit details
    Browse the repository at this point in the history

  5. reformatted ambisonics docstrings

    @MitchellAcoustics
    MitchellAcoustics committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    631398d View commit details
    Browse the repository at this point in the history

  6. started reformatting first standard

    @MitchellAcoustics
    MitchellAcoustics committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    430a388 View commit details
    Browse the repository at this point in the history

  7. Merge branch 'main' into doc-fix

    @MitchellAcoustics
    MitchellAcoustics committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    7d116d0 View commit details
    Browse the repository at this point in the history

Commits on Nov 1, 2024

  1. Merge pull request #34 from MitchellAcoustics/doc-fix 

    Bring WIP from my fork to the upstream
    @MitchellAcoustics
    MitchellAcoustics authored Nov 1, 2024
    Configuration menu
    Copy the full SHA
    a943acb View commit details
    Browse the repository at this point in the history