Code

Add documentation#123

Code

Merged

jenniferjiangkells merged 23 commits intomasteruclh-criu/miade:masterfrom documentationuclh-criu/miade:documentationCopy head branch name to clipboardJul 24, 2024

+1,510-198

Commits

Commits on Jul 18, 2024

• Initialise mkdocs

  jenniferjiangkells

  committed
  333b240

  Copy full SHA for 333b240

Commits on Jul 22, 2024

• Added mkdocs documentation site

  jenniferjiangkells

  committed
  fd0c620

  Copy full SHA for fd0c620

• Added docstrings to main APIs

  jenniferjiangkells

  committed
  6cb27f5

  Copy full SHA for 6cb27f5

Commits on Jul 23, 2024

• Added API reference

  jenniferjiangkells

  committed
  0067169

  Copy full SHA for 0067169

• Make docstrings google style

  jenniferjiangkells

  committed
  71c62c3

  Copy full SHA for 71c62c3

• Fix tests

  jenniferjiangkells

  committed
  b309790

  Copy full SHA for b309790

• Added config documentation page and license details

  jenniferjiangkells

  committed
  e4f9ef6

  Copy full SHA for e4f9ef6

• Update README.md

  jenniferjiangkells

  committed
  a8e9f92

  Copy full SHA for a8e9f92

• Add contributing guidelines and PR template

  jenniferjiangkells

  committed
  48b7758

  Copy full SHA for 48b7758

• Add ruff to dependencies and styleguide

  jenniferjiangkells

  committed
  b67f026

  Copy full SHA for b67f026

• Fix links

  jenniferjiangkells

  committed
  9e8df40

  Copy full SHA for 9e8df40

• Adde workflow to deploy documentation

  jenniferjiangkells

  committed
  fbf0528

  Copy full SHA for fbf0528

• Change main to master in workflow files

  jenniferjiangkells

  committed
  33eb832

  Copy full SHA for 33eb832

• Add link to contribution page

  jenniferjiangkells

  committed
  3c63f74

  Copy full SHA for 3c63f74

• Fix docs requirements extension

  jenniferjiangkells

  committed
  0fb4a06

  Copy full SHA for 0fb4a06

• Fix ci

  jenniferjiangkells

  committed
  b0a98fb

  Copy full SHA for b0a98fb

• Match ubuntu and python versions in git workflows

  jenniferjiangkells

  committed
  6f59124

  Copy full SHA for 6f59124

Commits on Jul 24, 2024

• Update pyproject.toml

  jenniferjiangkells

  committed
  ccba638

  Copy full SHA for ccba638

• Add installation instructions in README.md

  jenniferjiangkells

  committed
  6882b3a

  Copy full SHA for 6882b3a

• Update documentation

  jenniferjiangkells

  committed
  0454454

  Copy full SHA for 0454454

• Changes to Annotator abstract class to match API documentation and moved lookup back to package data for a default option

  jenniferjiangkells

  committed
  ce9021c

  Copy full SHA for ce9021c

• Added github workflow for publishing to pypi

  jenniferjiangkells

  committed
  9961eb9

  Copy full SHA for 9961eb9

• Formatting

  jenniferjiangkells

  committed
  4b75a79

  Copy full SHA for 4b75a79