diff options
| author |  Daenney <daenney@users.noreply.github.com> | 2024-02-12 12:05:35 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2024-02-12 11:05:35 +0000 |
| commit | 4a4017b0424ed4042a48f453b964ee10b0541ba9 (patch) | |
| tree | 05555f0494b4e4f7f9955a9287126c4ccba518d1 /CONTRIBUTING.md | |
| parent | Make GtS reported version SemVer-compatible (#2611) (diff) | |
| download | gotosocial-4a4017b0424ed4042a48f453b964ee10b0541ba9.tar.xz | |
[docs] Enable some new features (#2623)
* [docs] Enable a bunch of markdown extensions
* details makes admonitions collapsible and when started with ???
instead of !!! they'll be collpased by default
* highlights are updated to include linenums by default but with a style
that doesn't result in the linenums to be copy-pasted when selecting
and pasting. This makes it possible to directly link to a specific
line in the documentation instead of just the general page
* caret, mark and tilde make it possible to highlight text and have
super/subscripts
* keys turns combos like `++ctrl+alt+del++` into HTML key elements
showing a keyboard combination to press
* tabbed makes it possible to have tabs within a document. Right now we
have different sections sometimes to show the config for nginx, apache
and Caddy, which can be turned into tabs instead and which tab is
picked will get remebered
* smartsymbols turns certain things, like `(c)` in the right symbol ©
* [docs] Upgrade all the python dependencies
* [docs] Explain how to update conda deps
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3b71f9b39..1d7e11f8d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -110,6 +110,8 @@ 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. + ## Development ### Golang forking quirks |