Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
CamLamb committed Jun 17, 2024
1 parent c1269c5 commit 40fdd89
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 56 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ on:
push:
branches:
- main
# TODO: remove this before merging
- fix-documentation
jobs:
deploy:
runs-on: ubuntu-latest
Expand Down
12 changes: 6 additions & 6 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ extra:
# Standard config:
plugins:
- awesome-pages
- material/social:
cards_layout_options:
background_color: "#ffffff"
color: "#000000"
font_family: "Roboto"
# - material/social:
# cards_layout_options:
# background_color: "#ffffff"
# color: "#000000"
# font_family: "Roboto"
- material/search:
lang: en
- mkdocstrings:
Expand All @@ -29,7 +29,7 @@ plugins:
docstring_style: google

theme:
name: tech_docs_template
name: material
language: en
features:
- content.code.copy
Expand Down
116 changes: 72 additions & 44 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 5 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,13 @@ requests = "^2.32"
optional = true

[tool.poetry.group.docs.dependencies]
mkdocs-material = "~9.1.0"
mkdocs-minify-plugin = "^0.6.4"
mkdocs-redirects = "^1.2.0"
mkdocstrings-python = "^0.9.0"
mkdocs-material = "~9.5.27"
mkdocs-minify-plugin = "^0.7.1"
mkdocs-redirects = "^1.2.1"
mkdocstrings-python = "^1.10.3"
pillow = ">=9.5,<11.0"
cairosvg = "^2.7.0"
mkdocs-tech-docs-template = "^0.0.25"
mkdocs-awesome-pages-plugin = "^2.8.0"
mkdocs-awesome-pages-plugin = "^2.9.2"

[tool.isort]
profile = "black"
Expand Down

0 comments on commit 40fdd89

Please sign in to comment.