Code

Adding MkDocs docs to template#319

Code

Merged

matt-graham merged 25 commits intomainUCL-ARC/python-tooling:mainfrom mmg/mkdocs-docsUCL-ARC/python-tooling:mmg/mkdocs-docsCopy head branch name to clipboardMar 25, 2024

Commits

Commits on Mar 20, 2024

• Adding MkDocs docs to template

  matt-graham

  committed
  a5f0d52

  Copy full SHA for a5f0d52

• Add new line in docstring to satisfy Ruff

  matt-graham

  committed
  36a4fbd

  Copy full SHA for 36a4fbd

Commits on Mar 21, 2024

• Avoid repetition of docs dependencies

  matt-graham

  committed
  d33e871

  Copy full SHA for d33e871

• Fix typo and make title case consistent

  matt-graham

  committed
  d605092

  Copy full SHA for d605092

• Format frameworks as a list

  matt-graham

  committed
  ec12b11

  Copy full SHA for ec12b11

• Add edit URI for GitHub links

  matt-graham

  committed
  788c9f7

  Copy full SHA for 788c9f7

• Use MkDocs recommended stricter validation

  matt-graham

  committed
  ebebf85

  Copy full SHA for ebebf85

• Add GitHub social link

  matt-graham

  committed
  0de39ae

  Copy full SHA for 0de39ae

• Include README and license content in docs

  matt-graham

  committed
  81fa625

  Copy full SHA for 81fa625

• Tweak copyright line

  matt-graham

  committed
  248f1f3

  Copy full SHA for 248f1f3

• Correct reference to docs dependencies

  matt-graham

  committed
  0648c3a

  Copy full SHA for 0648c3a

• Rename license file in docs to make relative link from README work

  matt-graham

  committed
  04884a5

  Copy full SHA for 04884a5

• Add edit buttons to docs

  matt-graham

  committed
  f16841b

  Copy full SHA for f16841b

Commits on Mar 22, 2024

• Merge branch 'main' into mmg/mkdocs-docs

  paddyroddy

  authored
  414fd18

  Copy full SHA for 414fd18

• Apply suggestions from code review

  Show description for 442992e
  

  matt-graham

  and

  paddyroddy

  authored
  442992e

  Copy full SHA for 442992e

• Reorder tox testenv sections

  Show description for 2e67533
  

  matt-graham

  and

  paddyroddy

  committed
  2e67533

  Copy full SHA for 2e67533

• Add quotation marks around URL for consistency

  matt-graham

  committed
  f48174e

  Copy full SHA for f48174e

• Add vertical spacing between docs workflow job steps for consistency

  Show description for 483a19e
  

  matt-graham

  and

  paddyroddy

  committed
  483a19e

  Copy full SHA for 483a19e

• Adjust commented section indentation

  matt-graham

  committed
  2f6bace

  Copy full SHA for 2f6bace

• Remove spaces on empty lines

  matt-graham

  committed
  c36eb4f

  Copy full SHA for c36eb4f

• Add option to enable automatically docs to GitHub Pages to cookiecutter

  matt-graham

  committed
  dfa918a

  Copy full SHA for dfa918a

• Adjust newlines and whitespace control in template to satisfy prettier

  matt-graham

  committed
  5c874cf

  Copy full SHA for 5c874cf

• Switch from pymdownx.snippets extension to mkdocs-include-markdown-plugin

  matt-graham

  committed
  c23d7e6

  Copy full SHA for c23d7e6

• Remove indentation in include-markdown directive to satisfy prettier

  matt-graham

  committed
  832b262

  Copy full SHA for 832b262

Commits on Mar 25, 2024

• Update {{cookiecutter.project_slug}}/README.md

  Show description for fbb1d62
  

  matt-graham

  and

  samcunliffe

  authored
  fbb1d62

  Copy full SHA for fbb1d62