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

feanil/update rtd docs #208

Merged
merged 5 commits into from
Aug 31, 2023
Merged

feanil/update rtd docs #208

merged 5 commits into from
Aug 31, 2023

Commits on Aug 7, 2023

  1. docs: Add a ReadTheDocs config. 

    This format of config in the repo will be required starting in september
so add it now in preparation for that.
    @feanil
    feanil committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    67efd87 View commit details
    Browse the repository at this point in the history

  2. docs: Move to the new sphinx book theme.

    @feanil
    feanil committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    061f518 View commit details
    Browse the repository at this point in the history

  3. docs: Update to be able to pull in docstrings. 

    We need to actually setup django and its requirements to be able to
render autodocs.
    @feanil
    feanil committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    9ad307e View commit details
    Browse the repository at this point in the history

  4. docs: Update docstrings to not throw warnings. 

    Some of the docstrings were throwing warnings when we were trying to
render them in the docs site.  Update the docstrings so they don't throw
warnings.
    @feanil
    feanil committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    d200ba3 View commit details
    Browse the repository at this point in the history

  5. chore: Run make upgrade

    @feanil
    feanil committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    9844039 View commit details
    Browse the repository at this point in the history