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

Add API docs using Sphinx #59

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add API docs using Sphinx #59

wants to merge 7 commits into from

Commits on Nov 23, 2023

  1. docs: init Sphinx docs

    @michaeldickens
    michaeldickens committed Nov 23, 2023
    Configuration menu
    Copy the full SHA
    cc00f6c View commit details
    Browse the repository at this point in the history

  2. docs: generate using sphinx-apidoc

    @michaeldickens
    michaeldickens committed Nov 23, 2023
    Configuration menu
    Copy the full SHA
    397a0e6 View commit details
    Browse the repository at this point in the history

  3. docs: write better index page and link to all docs from index

    @michaeldickens
    michaeldickens committed Nov 23, 2023
    Configuration menu
    Copy the full SHA
    1446112 View commit details
    Browse the repository at this point in the history

  4. docs: move from docs to doc and fix docstring formatting

    @michaeldickens
    michaeldickens committed Nov 23, 2023
    Configuration menu
    Copy the full SHA
    8c29e78 View commit details
    Browse the repository at this point in the history

  5. docs: update Poetry dependencies for Sphinx requirements

    @michaeldickens
    michaeldickens committed Nov 23, 2023
    Configuration menu
    Copy the full SHA
    57ef85b View commit details
    Browse the repository at this point in the history

  6. docs: support numpydoc docstring style

    @michaeldickens
    michaeldickens committed Nov 23, 2023
    Configuration menu
    Copy the full SHA
    ffd5250 View commit details
    Browse the repository at this point in the history

  7. docs: don't track build/

    @michaeldickens
    michaeldickens committed Nov 23, 2023
    Configuration menu
    Copy the full SHA
    ffd5142 View commit details
    Browse the repository at this point in the history