Creation of multilingual documentation (#339)

* Creation of multilingual documentation * Update pyproject.toml --------- Co-authored-by: DJWOMS <[email protected]> Co-authored-by: tarsil <[email protected]>
dymmond · Jun 6, 2024 · 30ba89f · 30ba89f
1 parent f89f105
commit 30ba89f
Show file tree

Hide file tree

Showing 142 changed files with 1,509 additions and 809 deletions.
diff --git a/.github/workflows/test-suite.yml b/.github/workflows/test-suite.yml
@@ -5,8 +5,12 @@ on:
   push:
     branches:
       - "**"
+    paths-ignore:
+      - "docs/**"
   pull_request:
     branches: ["main"]
+    paths-ignore:
+      - "docs/**"
   schedule:
     - cron: "0 0 * * *"
 

diff --git a/.gitignore b/.gitignore
@@ -16,6 +16,8 @@ dist/
 node_modules/
 results/
 site/
+site_build/
+site_lang/
 target/
 
 # files

diff --git a/docs/contributing.md b/docs/contributing.md
diff --git a/docs/application/applications.md → docs/en/docs/application/applications.md b/docs/application/applications.md → docs/en/docs/application/applications.md
@@ -8,19 +8,19 @@ of its functionality.
 === "In a nutshell"
 
     ```python
-    {!> ../docs_src/application/app/nutshell.py !}
+    {!> ../../../docs_src/application/app/nutshell.py !}
     ```
 
 === "Another way"
 
     ```python
-    {!> ../docs_src/application/app/another_way.py!}
+    {!> ../../../docs_src/application/app/another_way.py!}
     ```
 
 === "With Include"
 
     ```python
-    {!> ../docs_src/application/app/with_include.py!}
+    {!> ../../../docs_src/application/app/with_include.py!}
     ```
 
 ### Quick note
@@ -132,19 +132,19 @@ To access the application settings there are different ways:
 === "Within the application request"
 
     ```python hl_lines="6"
-    {!> ../docs_src/application/settings/within_app_request.py!}
+    {!> ../../../docs_src/application/settings/within_app_request.py!}
     ```
 
 === "From the global settings"
 
     ```python hl_lines="1 6"
-    {!> ../docs_src/application/settings/global_settings.py!}
+    {!> ../../../docs_src/application/settings/global_settings.py!}
     ```
 
 === "From the conf settings"
 
     ```python hl_lines="2 7"
-    {!> ../docs_src/application/settings/conf_settings.py!}
+    {!> ../../../docs_src/application/settings/conf_settings.py!}
     ```
 
 ### State and application instance
@@ -154,7 +154,7 @@ You can store arbitrary extra state on the application instance using the State
 Example:
 
 ```python hl_lines="6"
-{!> ../docs_src/application/others/app_state.py!}
+{!> ../../../docs_src/application/others/app_state.py!}
 ```
 
 ## Accessing the application instance
@@ -164,7 +164,7 @@ The application instance can be access via `request` when it is available.
 Example:
 
 ```python hl_lines="6"
-{!> ../docs_src/application/others/access_app_instance.py!}
+{!> ../../../docs_src/application/others/access_app_instance.py!}
 ```
 
 ## Accessing the state from the application instance
@@ -174,5 +174,5 @@ The state can be access via `request` when it is available.
 Example:
 
 ```python hl_lines="7 11"
-{!> ../docs_src/application/others/access_state_from_app.py!}
+{!> ../../../docs_src/application/others/access_state_from_app.py!}
 ```
diff --git a/docs/application/levels.md → docs/en/docs/application/levels.md b/docs/application/levels.md → docs/en/docs/application/levels.md
@@ -8,7 +8,7 @@ An Esmerald application is composed by levels and those levels can be [Gateway](
 There are some levels in the application, let's use an example.
 
 ```python
-{!> ../docs_src/application/app/levels.py !}
+{!> ../../../docs_src/application/app/levels.py !}
 ```
 
 **Levels**:
@@ -24,7 +24,7 @@ You can create as many levels as you desire. From nested includes to
 ## With a ChildEsmerald
 
 ```python hl_lines="50 59"
-{!> ../docs_src/application/app/child_esmerald_level.py !}
+{!> ../../../docs_src/application/app/child_esmerald_level.py !}
 ```
 
 **Levels**:
@@ -60,7 +60,7 @@ In other words, you **don't need** to create/repeat the same permissions and mid
 every instance. They can be applied **globally** from the top main `Esmerald` object.
 
 ```python hl_lines="99-101 108 115 119-120"
-{!> ../docs_src/application/app/permissions_and_middlewares.py !}
+{!> ../../../docs_src/application/app/permissions_and_middlewares.py !}
 ```
 
 ### Notes