tobi
ee6e9b2795
[docs] Rework README a bit, import into docs ( #3006 )
2024-06-13 23:21:41 +02:00
tobi
be259b13a7
[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
2024-03-29 10:52:46 +01:00
Daenney
4a4017b042
[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
2024-02-12 11:05:35 +00:00
tobi
9b4b4d4eb8
[chore] update readthedocs deps, use conda ( #1742 )
...
* [chore] update readthedocs deps, use conda
* work this time thx
2023-05-06 17:33:37 +02:00
Daenney
40eea3b409
[feature] Use Material theme for docs ( #1535 )
...
* [feature] Use Material theme for docs
This changes the theme to use Material with the slate (dark) theme and
the accent colour set to orange. It also replaces the swagger plugin
with one that works correctly with the Material theming.
* Add theme by @f0x52
Co-authored-by: f0x52 <f0x@cthu.lu>
* Enable social cards
The dependencies for cairosvg and pillow can be satisfied on RTD, so
this adds them to our requirements.txt and enables the social plugin.
This generates opengraph and twitter card tags as well as fancy preview
images in GTS colour style for platforms that show that as part of link
previews.
* Update Conda environment.yml
* update theme for swagger, basic light theme option
* dark mode mobile header bg color
---------
Co-authored-by: f0x52 <f0x@cthu.lu>
2023-02-20 23:09:17 +01:00
tobi
d81a123473
Update docs with better config + installation instructions ( #300 )
...
* start reworking some documentation
* fuller documentation + better docs structure
2021-11-14 16:54:23 +01:00
Tobi Smethurst
05e9af089c
Oidc ( #109 )
...
* add oidc config
* inching forward with oidc idp
* lil webfingy fix
* bit more progress
* further oidc
* oidc now working
* document dex config
* replace broken images
* add additional credits
* tiny doc update
* update
* add oidc config
* inching forward with oidc idp
* bit more progress
* further oidc
* oidc now working
* document dex config
* replace broken images
* add additional credits
* tiny doc update
* update
* document
* docs + comments
2021-07-23 10:36:28 +02:00
tsmethurst
7867fdebd2
add theme to conda env
2021-02-28 17:22:48 +01:00
tsmethurst
e68b72ddf9
add docs and a bunch of other stuff
2021-02-28 15:17:18 +01:00
