[chore] Vendor mkdocs fonts; update docs dependencies (#2789)

* [chore] Update docs dependencies

* update rtd deps

* aaaa

* why can't you just be normal!

* vendor social plugin fonts
This commit is contained in:
tobi 2024-03-29 10:52:46 +01:00 committed by GitHub
parent 72b38c2f12
commit be259b13a7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
17 changed files with 18 additions and 10 deletions

5
.gitignore vendored
View File

@ -37,5 +37,6 @@ shell.nix
/.idea/ /.idea/
/.fleet/ /.fleet/
# ignore cache dir from mkdocs serve # ignore cached pngs from mkdocs serve,
/.cache # while preserving cached fonts.
/docs/.cache/plugin/social/*.png

View File

@ -6,9 +6,9 @@
version: 2 version: 2
build: build:
os: "ubuntu-20.04" os: ubuntu-22.04
tools: tools:
python: "mambaforge-4.10" # https://docs.readthedocs.io/en/stable/guides/conda.html#making-builds-faster-with-mamba python: "mambaforge-22.9" # https://docs.readthedocs.io/en/stable/guides/conda.html#making-builds-faster-with-mamba
mkdocs: mkdocs:
configuration: "mkdocs.yml" configuration: "mkdocs.yml"

View File

@ -110,7 +110,13 @@ When adding a new page, you need to include it in the [`mkdocs.yml`](mkdocs.yml)
If you don't use Conda, you can read the `docs/environment.yml` to see which dependencies are required and `pip install` them manually. It's advisable to do this in a virtual environment, which you can create with something like `python3 -m venv /path-to/store-the-venv`. You can then call `/path-to/store-the-venv/bin/pip`, `/path-to/store-the-venv/bin/mkdocs` etc. If you don't use Conda, you can read the `docs/environment.yml` to see which dependencies are required and `pip install` them manually. It's advisable to do this in a virtual environment, which you can create with something like `python3 -m venv /path-to/store-the-venv`. You can then call `/path-to/store-the-venv/bin/pip`, `/path-to/store-the-venv/bin/mkdocs` etc.
In order to upgrade dependencies, use `conda update --update-all` in the activated environment. You can then update the `environment.yml` with `conda env export --from-history -f ./docs/environment.yml`, though you'll need to fix the `channels`. Beware that `conda env export` will also drop the `pip` dependencies, so make sure to add those back. In order to upgrade dependencies, use `conda update --update-all` in the activated environment. You can then update the `environment.yml` with:
```sh
conda env export -n gotosocial-docs --from-history --override-channels -c conda-forge -c nodefaults -f ./docs/environment.yml
```
Beware that `conda env export` will add a `prefix` entry to the environment.yml file, and drop the `pip` dependencies, so make sure to remove the prefix and add the `pip` dependencies back in.
## Development ## Development

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -5,10 +5,10 @@ channels:
dependencies: dependencies:
- cairosvg==2.7.1 - cairosvg==2.7.1
- mkdocs-material-extensions==1.3.1 - mkdocs-material-extensions==1.3.1
- mkdocs-material==9.5.8 - mkdocs-material==9.5.15
- mkdocs==1.5.3 - mkdocs==1.5.3
- pillow==10.0.0 - pillow==10.2.0
- pip==23.3.1 - pip==24
- python==3.11.3=h2755cc3_0_cpython - python==3.12
- pip: - pip:
- mkdocs-swagger-ui-tag==0.6.8 - mkdocs-swagger-ui-tag==0.6.9

View File

@ -28,6 +28,7 @@ plugins:
cards_layout_options: cards_layout_options:
background_color: "#fd6a00" background_color: "#fd6a00"
color: "#fafaff" color: "#fafaff"
cache_dir: "./docs/.cache/plugin/social"
- swagger-ui-tag: - swagger-ui-tag:
supportedSubmitMethods: [] supportedSubmitMethods: []
syntaxHighlightTheme: obsidian syntaxHighlightTheme: obsidian