Code

Adds documentation site#141

Code

Merged

BradyPlanden merged 24 commits intodeveloppybop-team/PyBOP:developfrom 15-create-documentation-for-pyboppybop-team/PyBOP:15-create-documentation-for-pybopCopy head branch name to clipboardDec 14, 2023

+2,303-553

Commits

Commits on Oct 27, 2023

• Add Initial Sphinx Docs

  BradyPlanden

  committed
  1ca8d4f

  Copy full SHA for 1ca8d4f

Commits on Dec 6, 2023

• Merge branch 'develop' into 15-create-documentation-for-pybop

  BradyPlanden

  committed
  82c7849

  Copy full SHA for 82c7849

Commits on Dec 8, 2023

• doc dependancies

  BradyPlanden

  committed
  7f887af

  Copy full SHA for 7f887af

• Adds User Guide, Installation, and Quick Start

  BradyPlanden

  committed
  3134b3d

  Copy full SHA for 3134b3d

• Add nox session for docs, add pip install option for docs

  BradyPlanden

  committed
  ddae288

  Copy full SHA for ddae288

Commits on Dec 10, 2023

• Updt cost, dataset structure, improve docstrings, iterate on docs site

  BradyPlanden

  committed
  f98355a

  Copy full SHA for f98355a

• Merge branch 'develop' into 15-create-documentation-for-pybop

  BradyPlanden

  committed
  d0499f3

  Copy full SHA for d0499f3

• Updts docstrings across package, remove redundant base naming convention for certain filenames

  BradyPlanden

  committed
  dafa750

  Copy full SHA for dafa750

Commits on Dec 11, 2023

• Add deploy docs workflow

  BradyPlanden

  committed
  8743034

  Copy full SHA for 8743034

• Add workflow dispatch to deploy workflow

  BradyPlanden

  committed
  17e60ca

  Copy full SHA for 17e60ca

• updt permissions for deployment action

  BradyPlanden

  committed
  6909d30

  Copy full SHA for 6909d30

• Finish docstring update, add pypi icon, update links & frontpage

  BradyPlanden

  committed
  5dfec0b

  Copy full SHA for 5dfec0b

• Updts. changelog and contributing, reverts deployment workflow trigger to on release

  BradyPlanden

  committed
  cec7d64

  Copy full SHA for cec7d64

• Updt deployment to use nox session

  BradyPlanden

  committed
  32d6766

  Copy full SHA for 32d6766

• restores on push deployment for testing

  BradyPlanden

  committed
  33ca4d0

  Copy full SHA for 33ca4d0

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

  BradyPlanden

  committed
  32f5a27

  Copy full SHA for 32f5a27

• Remove treat warnings as errors

  BradyPlanden

  committed
  c34a9ea

  Copy full SHA for c34a9ea

• relocate _build directory for deployable access

  BradyPlanden

  committed
  3a0b2b4

  Copy full SHA for 3a0b2b4

Commits on Dec 12, 2023

• Tidy conf.py

  BradyPlanden

  committed
  a807a56

  Copy full SHA for a807a56

Commits on Dec 13, 2023

• Updt noxfile for notebooks, optimisation.py change to _optimisation.py, updt .gitignore, trigger deploy on release only

  BradyPlanden

  committed
  7aaa4a8

  Copy full SHA for 7aaa4a8

Commits on Dec 14, 2023

• Automate version linking

  BradyPlanden

  committed
  6ac1880

  Copy full SHA for 6ac1880

• Updt. landing page grid and header names, docstring typos, contributing render method

  BradyPlanden

  committed
  af10b31

  Copy full SHA for af10b31

• Add readthedocs configuration

  BradyPlanden

  committed
  a51d720

  Copy full SHA for a51d720

• Add version switcher, updt header location, link rtd versions

  BradyPlanden

  committed
  a0d44e5

  Copy full SHA for a0d44e5