Skip to content

Commit

Permalink
docs: remove everything related to sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
stollero committed Oct 14, 2024
1 parent cb0caf8 commit cf492c5
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 211 deletions.
177 changes: 0 additions & 177 deletions docs/Makefile

This file was deleted.

1 change: 0 additions & 1 deletion docs/_build/.gitignore

This file was deleted.

5 changes: 2 additions & 3 deletions docs/application/i18n.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Internationalization

:::{note}
The i18n Feature is currently not actively supported anymore - the workaround is to translate the texts using the theming mechanism, where you can replace tagged markup with translated versions.
:::
!!! note
The i18n Feature is currently not actively supported anymore - the workaround is to translate the texts using the theming mechanism, where you can replace tagged markup with translated versions.

All user facing text of the `briefkasen` application are translated using a `gettext` messsage catalog. To customize and update these messages you must:

Expand Down
10 changes: 0 additions & 10 deletions docs/compose.yaml

This file was deleted.

13 changes: 0 additions & 13 deletions docs/conf.py

This file was deleted.

4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ Upon successful upload the submitter receives a unique URL with a token that he

The implementation doesn't just contain the application itself but includes a complete deployment setup following what we believe to be best practices so that anybody should be able to host their own secure `briefkasten` with minimal setup pain.

Deployment
[Deployment](deployment/index.md)

> This section contains all the information on how to install, configure and run your own instance of the briefkasten stack.
Application
[Application](application/develop.md)

> This section contains information on the inner workings of the application and how to develop or extend it or how to create a custom theme for it.
10 changes: 5 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ repo_url: https://github.com/ZeitOnline/briefkasten
nav:
- index.md
- Deployment:
- index.md
- monitoring.md
- deployment/index.md
- deployment/monitoring.md
- Application:
- develop.md
- workings.md
- i18n.md
- application/develop.md
- application/workings.md
- application/i18n.md

0 comments on commit cf492c5

Please sign in to comment.