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

Adds documentation site #141

Merged
merged 24 commits into from
Dec 14, 2023
Merged

Adds documentation site #141

merged 24 commits into from
Dec 14, 2023

Commits on Oct 27, 2023

  1. Add Initial Sphinx Docs

    @BradyPlanden
    BradyPlanden committed Oct 27, 2023
    Configuration menu
    Copy the full SHA
    1ca8d4f View commit details
    Browse the repository at this point in the history

Commits on Dec 6, 2023

  1. Merge branch 'develop' into 15-create-documentation-for-pybop

    @BradyPlanden
    BradyPlanden committed Dec 6, 2023
    Configuration menu
    Copy the full SHA
    82c7849 View commit details
    Browse the repository at this point in the history

Commits on Dec 8, 2023

  1. doc dependancies

    @BradyPlanden
    BradyPlanden committed Dec 8, 2023
    Configuration menu
    Copy the full SHA
    7f887af View commit details
    Browse the repository at this point in the history

  2. Adds User Guide, Installation, and Quick Start

    @BradyPlanden
    BradyPlanden committed Dec 8, 2023
    Configuration menu
    Copy the full SHA
    3134b3d View commit details
    Browse the repository at this point in the history

  3. Add nox session for docs, add pip install option for docs

    @BradyPlanden
    BradyPlanden committed Dec 8, 2023
    Configuration menu
    Copy the full SHA
    ddae288 View commit details
    Browse the repository at this point in the history

Commits on Dec 10, 2023

  1. Updt cost, dataset structure, improve docstrings, iterate on docs site

    @BradyPlanden
    BradyPlanden committed Dec 10, 2023
    Configuration menu
    Copy the full SHA
    f98355a View commit details
    Browse the repository at this point in the history

  2. Merge branch 'develop' into 15-create-documentation-for-pybop

    @BradyPlanden
    BradyPlanden committed Dec 10, 2023
    Configuration menu
    Copy the full SHA
    d0499f3 View commit details
    Browse the repository at this point in the history

  3. Updts docstrings across package, remove redundant base naming convent… 

    …ion for certain filenames
    @BradyPlanden
    BradyPlanden committed Dec 10, 2023
    Configuration menu
    Copy the full SHA
    dafa750 View commit details
    Browse the repository at this point in the history

Commits on Dec 11, 2023

  1. Add deploy docs workflow

    @BradyPlanden
    BradyPlanden committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    8743034 View commit details
    Browse the repository at this point in the history

  2. Add workflow dispatch to deploy workflow

    @BradyPlanden
    BradyPlanden committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    17e60ca View commit details
    Browse the repository at this point in the history

  3. updt permissions for deployment action

    @BradyPlanden
    BradyPlanden committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    6909d30 View commit details
    Browse the repository at this point in the history

  4. Finish docstring update, add pypi icon, update links & frontpage

    @BradyPlanden
    BradyPlanden committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    5dfec0b View commit details
    Browse the repository at this point in the history

  5. Updts. changelog and contributing, reverts deployment workflow trigge… 

    …r to on release
    @BradyPlanden
    BradyPlanden committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    cec7d64 View commit details
    Browse the repository at this point in the history

  6. Updt deployment to use nox session

    @BradyPlanden
    BradyPlanden committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    32d6766 View commit details
    Browse the repository at this point in the history

  7. restores on push deployment for testing

    @BradyPlanden
    BradyPlanden committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    33ca4d0 View commit details
    Browse the repository at this point in the history

  8. Remove duplicate docstrings, updt broken links in contributing.md

    @BradyPlanden
    BradyPlanden committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    32f5a27 View commit details
    Browse the repository at this point in the history

  9. Remove treat warnings as errors

    @BradyPlanden
    BradyPlanden committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    c34a9ea View commit details
    Browse the repository at this point in the history

  10. relocate _build directory for deployable access

    @BradyPlanden
    BradyPlanden committed Dec 11, 2023
    Configuration menu
    Copy the full SHA
    3a0b2b4 View commit details
    Browse the repository at this point in the history

Commits on Dec 12, 2023

  1. Tidy conf.py

    @BradyPlanden
    BradyPlanden committed Dec 12, 2023
    Configuration menu
    Copy the full SHA
    a807a56 View commit details
    Browse the repository at this point in the history

Commits on Dec 13, 2023

  1. Updt noxfile for notebooks, optimisation.py change to _optimisation.p… 

    …y, updt .gitignore, trigger deploy on release only
    @BradyPlanden
    BradyPlanden committed Dec 13, 2023
    Configuration menu
    Copy the full SHA
    7aaa4a8 View commit details
    Browse the repository at this point in the history

Commits on Dec 14, 2023

  1. Automate version linking

    @BradyPlanden
    BradyPlanden committed Dec 14, 2023
    Configuration menu
    Copy the full SHA
    6ac1880 View commit details
    Browse the repository at this point in the history

  2. Updt. landing page grid and header names, docstring typos, contributi… 

    …ng render method
    @BradyPlanden
    BradyPlanden committed Dec 14, 2023
    Configuration menu
    Copy the full SHA
    af10b31 View commit details
    Browse the repository at this point in the history

  3. Add readthedocs configuration

    @BradyPlanden
    BradyPlanden committed Dec 14, 2023
    Configuration menu
    Copy the full SHA
    a51d720 View commit details
    Browse the repository at this point in the history

  4. Add version switcher, updt header location, link rtd versions

    @BradyPlanden
    BradyPlanden committed Dec 14, 2023
    Configuration menu
    Copy the full SHA
    a0d44e5 View commit details
    Browse the repository at this point in the history