diff --git a/.gitignore b/.gitignore index 7b856448c..a7a61ed2a 100644 --- a/.gitignore +++ b/.gitignore @@ -37,5 +37,6 @@ shell.nix /.idea/ /.fleet/ -# ignore cache dir from mkdocs serve -/.cache +# ignore cached pngs from mkdocs serve, +# while preserving cached fonts. +/docs/.cache/plugin/social/*.png diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e7be47aa6..46ceb2925 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,9 +6,9 @@ version: 2 build: - os: "ubuntu-20.04" + os: ubuntu-22.04 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: configuration: "mkdocs.yml" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8610f5159..cd0df69d7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. -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 diff --git a/docs/.cache/plugin/social/Roboto-Black.ttf b/docs/.cache/plugin/social/Roboto-Black.ttf new file mode 100644 index 000000000..0112e7da6 Binary files /dev/null and b/docs/.cache/plugin/social/Roboto-Black.ttf differ diff --git a/docs/.cache/plugin/social/Roboto-BlackItalic.ttf b/docs/.cache/plugin/social/Roboto-BlackItalic.ttf new file mode 100644 index 000000000..b2c6aca57 Binary files /dev/null and b/docs/.cache/plugin/social/Roboto-BlackItalic.ttf differ diff --git a/docs/.cache/plugin/social/Roboto-Bold.ttf b/docs/.cache/plugin/social/Roboto-Bold.ttf new file mode 100644 index 000000000..43da14d84 Binary files /dev/null and b/docs/.cache/plugin/social/Roboto-Bold.ttf differ diff --git a/docs/.cache/plugin/social/Roboto-BoldItalic.ttf b/docs/.cache/plugin/social/Roboto-BoldItalic.ttf new file mode 100644 index 000000000..bcfdab431 Binary files /dev/null and b/docs/.cache/plugin/social/Roboto-BoldItalic.ttf differ diff --git a/docs/.cache/plugin/social/Roboto-Italic.ttf b/docs/.cache/plugin/social/Roboto-Italic.ttf new file mode 100644 index 000000000..1b5eaa361 Binary files /dev/null and b/docs/.cache/plugin/social/Roboto-Italic.ttf differ diff --git a/docs/.cache/plugin/social/Roboto-Light.ttf b/docs/.cache/plugin/social/Roboto-Light.ttf new file mode 100644 index 000000000..e7307e72c Binary files /dev/null and b/docs/.cache/plugin/social/Roboto-Light.ttf differ diff --git a/docs/.cache/plugin/social/Roboto-LightItalic.ttf b/docs/.cache/plugin/social/Roboto-LightItalic.ttf new file mode 100644 index 000000000..2d277afb2 Binary files /dev/null and b/docs/.cache/plugin/social/Roboto-LightItalic.ttf differ diff --git a/docs/.cache/plugin/social/Roboto-Medium.ttf b/docs/.cache/plugin/social/Roboto-Medium.ttf new file mode 100644 index 000000000..ac0f908b9 Binary files /dev/null and b/docs/.cache/plugin/social/Roboto-Medium.ttf differ diff --git a/docs/.cache/plugin/social/Roboto-MediumItalic.ttf b/docs/.cache/plugin/social/Roboto-MediumItalic.ttf new file mode 100644 index 000000000..fc36a4785 Binary files /dev/null and b/docs/.cache/plugin/social/Roboto-MediumItalic.ttf differ diff --git a/docs/.cache/plugin/social/Roboto-Regular.ttf b/docs/.cache/plugin/social/Roboto-Regular.ttf new file mode 100644 index 000000000..ddf4bfacb Binary files /dev/null and b/docs/.cache/plugin/social/Roboto-Regular.ttf differ diff --git a/docs/.cache/plugin/social/Roboto-Thin.ttf b/docs/.cache/plugin/social/Roboto-Thin.ttf new file mode 100644 index 000000000..2e0dee6a8 Binary files /dev/null and b/docs/.cache/plugin/social/Roboto-Thin.ttf differ diff --git a/docs/.cache/plugin/social/Roboto-ThinItalic.ttf b/docs/.cache/plugin/social/Roboto-ThinItalic.ttf new file mode 100644 index 000000000..084f9c0f5 Binary files /dev/null and b/docs/.cache/plugin/social/Roboto-ThinItalic.ttf differ diff --git a/docs/environment.yml b/docs/environment.yml index 9aace2d4e..fe4f2c8ba 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -5,10 +5,10 @@ channels: dependencies: - cairosvg==2.7.1 - mkdocs-material-extensions==1.3.1 - - mkdocs-material==9.5.8 + - mkdocs-material==9.5.15 - mkdocs==1.5.3 - - pillow==10.0.0 - - pip==23.3.1 - - python==3.11.3=h2755cc3_0_cpython + - pillow==10.2.0 + - pip==24 + - python==3.12 - pip: - - mkdocs-swagger-ui-tag==0.6.8 + - mkdocs-swagger-ui-tag==0.6.9 diff --git a/mkdocs.yml b/mkdocs.yml index e808ab6b6..b2eb019ab 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,6 +28,7 @@ plugins: cards_layout_options: background_color: "#fd6a00" color: "#fafaff" + cache_dir: "./docs/.cache/plugin/social" - swagger-ui-tag: supportedSubmitMethods: [] syntaxHighlightTheme: obsidian