From 62798c809bc77703f23425d3fa78f7e518c7824d Mon Sep 17 00:00:00 2001 From: TheJoKlLa Date: Mon, 13 May 2024 13:54:41 +0200 Subject: [PATCH] Added: Translation --- .gitlab-ci.yml | 24 +++++++++++++++++++++++ .readthedocs.yaml | 2 +- README.md | 3 +-- docs/api.md | 3 +-- docs/index.de.md | 1 + docs/index.en.md | 1 + docs/index.md | 4 ---- docs/requirements.in | 3 --- mkdocs.yml | 17 +++++++++++++--- docs/requirements.txt => requirements.txt | 2 ++ 10 files changed, 45 insertions(+), 15 deletions(-) create mode 100644 .gitlab-ci.yml create mode 100644 docs/index.de.md create mode 100644 docs/index.en.md delete mode 100644 docs/index.md delete mode 100644 docs/requirements.in rename docs/requirements.txt => requirements.txt (96%) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..c892a4c --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,24 @@ +image: python:3.8-buster + +before_script: + - pip install -r requirements.txt + +test: + stage: test + script: + - mkdocs build --strict --verbose --site-dir test + artifacts: + paths: + - test + rules: + - if: $CI_COMMIT_REF_NAME != $CI_DEFAULT_BRANCH + +pages: + stage: deploy + script: + - mkdocs build --strict --verbose + artifacts: + paths: + - public + rules: + - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 37ceb77..0518481 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -17,4 +17,4 @@ mkdocs: # Optionally declare the Python requirements required to build your docs python: install: - - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/README.md b/README.md index 770202d..70ad3e3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ # fabaccess-docs Documentation for the fabaccess project. -You can find the rendered docs at: https://fab-access.readthedocs.io/ - +You can find the rendered docs at: https://fab-access.readthedocs.io/ or https://docs.fab-access.org diff --git a/docs/api.md b/docs/api.md index ecbc0fb..b2fad2e 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,2 +1 @@ -# API Reference - +# API Reference \ No newline at end of file diff --git a/docs/index.de.md b/docs/index.de.md new file mode 100644 index 0000000..7ca4df7 --- /dev/null +++ b/docs/index.de.md @@ -0,0 +1 @@ +# Wilkommen DE \ No newline at end of file diff --git a/docs/index.en.md b/docs/index.en.md new file mode 100644 index 0000000..6e695ee --- /dev/null +++ b/docs/index.en.md @@ -0,0 +1 @@ +# Welcome EN \ No newline at end of file diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 1df4d0b..0000000 --- a/docs/index.md +++ /dev/null @@ -1,4 +0,0 @@ -{!README.md!} - -# Welcome to Lumache's documentation! - diff --git a/docs/requirements.in b/docs/requirements.in deleted file mode 100644 index bec300c..0000000 --- a/docs/requirements.in +++ /dev/null @@ -1,3 +0,0 @@ -mkdocs -mkdocstrings[python] -markdown-include diff --git a/mkdocs.yml b/mkdocs.yml index 2a5a12e..ade9902 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,12 @@ -site_name: Basic MkDocs Example Project +site_name: FabAccess Documentation +# site_url: https://pages.gitlab.io/mkdocs +site_dir: public + theme: - name: readthedocs - highlightjs: true + name: material + palette: + primary: blue + plugins: - search - mkdocstrings: @@ -10,6 +15,12 @@ plugins: python: options: docstring_style: sphinx + - i18n: + default_language: en + languages: + en: English + de: Deutsch + markdown_extensions: - markdown_include.include: base_path: . diff --git a/docs/requirements.txt b/requirements.txt similarity index 96% rename from docs/requirements.txt rename to requirements.txt index b1e9e01..087b4e3 100644 --- a/docs/requirements.txt +++ b/requirements.txt @@ -44,6 +44,8 @@ mkdocstrings[python]==0.19.0 # mkdocstrings-python mkdocstrings-python==0.7.1 # via mkdocstrings +mkdocs-material == 7.1.11 +mkdocs-static-i18n == 0.18 packaging==21.3 # via mkdocs pymdown-extensions==9.5