Skip to content

Commit

Permalink
docs: fix readthedocs build (#3824)
Browse files Browse the repository at this point in the history
Mkdocs failing on 
```
ERROR - Required dependencies of "social" plugin not found:
- ModuleNotFoundError("No module named 'cairosvg'")
  • Loading branch information
ccmao1130 authored Feb 19, 2025
1 parent ed56fe3 commit 47fde8a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,6 @@ out
# typescript
*.tsbuildinfo
next-env.d.ts

# added by mkdocs social cards
.cache
5 changes: 4 additions & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -166,4 +166,7 @@ plugins:
- mkdocs-simple-hooks:
hooks:
on_pre_build: "docs.hooks:make_api_docs"
- social
- social:
cards_layout_options:
background_color: "#532687"
cards_dir: social
1 change: 1 addition & 0 deletions requirements-docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ mkdocs-material
mkdocs-macros-plugin
mkdocs-simple-hooks
pymdown-extensions
mkdocs-material[imaging]

0 comments on commit 47fde8a

Please sign in to comment.