[chore] Update docs dependencies

This commit is contained in:
tobi 2024-03-28 15:17:30 +01:00
parent 4f66dba139
commit ccdd34fa5d
2 changed files with 12 additions and 6 deletions

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

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