Skip to content

Commit

Permalink
Enhance documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
marcauberer committed Mar 7, 2024
1 parent 63b3ac2 commit 49f8626
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 3 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ jobs:
python-version: 3.x

- name: Install dependencies
run: pip install -r docs/requirements.txt
run: |
sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev pngquant
pip install -r docs/requirements.txt
- name: Build and deploy
working-directory: docs
Expand Down
17 changes: 15 additions & 2 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,18 @@ theme:
name: material
custom_dir: docs/overrides
language: en
logo: static/avatar.png
favicon: static/favicon-96x96.ico
icon:
logo: static/avatar.png
include_search_page: false
search_index_only: true
features:
- navigation.instant
- navigation.tabs
- navigation.top
- content.code.copy
- content.action.edit
- content.action.view
- announce.dismiss
palette:
- media: "(prefers-color-scheme)" # System preference
Expand Down Expand Up @@ -52,8 +55,12 @@ plugins:
- en
- minify:
minify_html: true
- social

extra:
status:
new: Recently added
deprecated: Deprecated
social:
- icon: fontawesome/brands/github
link: https://github.com/spicelang/spice
Expand Down Expand Up @@ -115,7 +122,6 @@ nav:
- contributing.md

markdown_extensions:
- codehilite
- meta
- footnotes
- admonition
Expand All @@ -126,6 +132,13 @@ markdown_extensions:
alternate_style: true
- pymdownx.superfences
- attr_list
- pymdownx.highlight:
auto_title: true
linenums: true
anchor_linenums: true
use_pygments: true
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
mkdocs-material==9.5.12
mkdocs-material[imaging]==9.5.12
mkdocs-minify-plugin==0.8.0
mkdocs-git-revision-date-localized-plugin==1.2.4
mkdocs-git-committers-plugin-2==2.3.0
Expand Down

0 comments on commit 49f8626

Please sign in to comment.