summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2024-03-29 10:52:46 +0100
committerLibravatar GitHub <noreply@github.com>2024-03-29 10:52:46 +0100
commitbe259b13a7ab67c6a8917b764166468ef09a08a1 (patch)
tree197aa07f68a795527a15df8e6e7f917fd7db289e
parent[chore] Bump express from 4.18.2 to 4.19.2 in /web/source (#2790) (diff)
downloadgotosocial-be259b13a7ab67c6a8917b764166468ef09a08a1.tar.xz
[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
-rw-r--r--.gitignore5
-rw-r--r--.readthedocs.yaml4
-rw-r--r--CONTRIBUTING.md8
-rw-r--r--docs/.cache/plugin/social/Roboto-Black.ttfbin0 -> 168060 bytes
-rw-r--r--docs/.cache/plugin/social/Roboto-BlackItalic.ttfbin0 -> 174108 bytes
-rw-r--r--docs/.cache/plugin/social/Roboto-Bold.ttfbin0 -> 167336 bytes
-rw-r--r--docs/.cache/plugin/social/Roboto-BoldItalic.ttfbin0 -> 171508 bytes
-rw-r--r--docs/.cache/plugin/social/Roboto-Italic.ttfbin0 -> 170504 bytes
-rw-r--r--docs/.cache/plugin/social/Roboto-Light.ttfbin0 -> 167000 bytes
-rw-r--r--docs/.cache/plugin/social/Roboto-LightItalic.ttfbin0 -> 173172 bytes
-rw-r--r--docs/.cache/plugin/social/Roboto-Medium.ttfbin0 -> 168644 bytes
-rw-r--r--docs/.cache/plugin/social/Roboto-MediumItalic.ttfbin0 -> 173416 bytes
-rw-r--r--docs/.cache/plugin/social/Roboto-Regular.ttfbin0 -> 168260 bytes
-rw-r--r--docs/.cache/plugin/social/Roboto-Thin.ttfbin0 -> 168488 bytes
-rw-r--r--docs/.cache/plugin/social/Roboto-ThinItalic.ttfbin0 -> 172860 bytes
-rw-r--r--docs/environment.yml10
-rw-r--r--mkdocs.yml1
17 files changed, 18 insertions, 10 deletions
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
--- /dev/null
+++ b/docs/.cache/plugin/social/Roboto-Black.ttf
Binary files 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
--- /dev/null
+++ b/docs/.cache/plugin/social/Roboto-BlackItalic.ttf
Binary files 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
--- /dev/null
+++ b/docs/.cache/plugin/social/Roboto-Bold.ttf
Binary files 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
--- /dev/null
+++ b/docs/.cache/plugin/social/Roboto-BoldItalic.ttf
Binary files 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
--- /dev/null
+++ b/docs/.cache/plugin/social/Roboto-Italic.ttf
Binary files 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
--- /dev/null
+++ b/docs/.cache/plugin/social/Roboto-Light.ttf
Binary files 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
--- /dev/null
+++ b/docs/.cache/plugin/social/Roboto-LightItalic.ttf
Binary files 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
--- /dev/null
+++ b/docs/.cache/plugin/social/Roboto-Medium.ttf
Binary files 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
--- /dev/null
+++ b/docs/.cache/plugin/social/Roboto-MediumItalic.ttf
Binary files 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
--- /dev/null
+++ b/docs/.cache/plugin/social/Roboto-Regular.ttf
Binary files 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
--- /dev/null
+++ b/docs/.cache/plugin/social/Roboto-Thin.ttf
Binary files 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
--- /dev/null
+++ b/docs/.cache/plugin/social/Roboto-ThinItalic.ttf
Binary files 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