fix : typo in mkdocs

fix : file in maj add : usage file
PyDFIR · Aug 21, 2024 · 1528702 · 1528702
1 parent 2a38351
commit 1528702
Show file tree

Hide file tree

Showing 9 changed files with 14 additions and 20 deletions.
diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
@@ -4,7 +4,6 @@ on:
     branches:
       - main
       - dev
-
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -13,17 +12,12 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: 3.11
+      - run: pip install mkdocs mkdocs-material mkdocstrings[python] mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2
+      - run: mkdocs gh-deploy --force --clean --verbose
 
-      # Install required dependencies
-      - run: pip install mkdocs mkdocs-material mkdocstrings[python] mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mike
-
-      # Deploy the documentation
-      - name: Deploy documentation
-        run: |
-          BRANCH=$(echo "${GITHUB_REF#refs/heads/}")
-          if [ "$BRANCH" = "main" ]; then
-            mike deploy --update-aliases latest
-          elif [ "$BRANCH" = "dev" ]; then
-            mike deploy dev
-          fi
-          mike deploy --push --clean
+name: build-mkdocs
+on:
+  push:
+    branches:
+      - main
+      - dev
diff --git a/docs/Tutorials/usage.md → docs/guide/guide.md b/docs/Tutorials/usage.md → docs/guide/guide.md
diff --git a/docs/Guide/test.md → docs/guide/test.md b/docs/Guide/test.md → docs/guide/test.md
diff --git a/docs/index.md b/docs/index.md
@@ -8,8 +8,8 @@ project documentation as described by Daniele Procida
 in the [Diátaxis documentation framework](https://diataxis.fr/)
 and consists of four separate parts:
 
-1. [Tutorials](./Tutorials/installation.md)
-2. [How-To Guides](./Usage/usage.md)
+1. [Tutorials](./tutorials/installation.md)
+2. [How-To Guides](./Guide/usage.md)
 3. [Reference](./reference/reference.md)
 4. [Explanation](./explanation.md)
 

diff --git a/docs/Tutorials/installation.md → docs/tutorials/installation.md b/docs/Tutorials/installation.md → docs/tutorials/installation.md
diff --git a/docs/Tutorials/linux.md → docs/tutorials/linux.md b/docs/Tutorials/linux.md → docs/tutorials/linux.md
diff --git a/docs/tutorials/usage.md b/docs/tutorials/usage.md
diff --git a/docs/Tutorials/windows.md → docs/tutorials/windows.md b/docs/Tutorials/windows.md → docs/tutorials/windows.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -55,9 +55,9 @@ markdown_extensions:
 nav:
   - index.md
   - Tutorials:
-    - Installation : Tutorials/installation.md
-    - Windows : Tutorials/windows.md
-    - Linux/Mac : Tutorials/linux.md
+    - Installation : tutorials/installation.md
+    - Windows : tutorials/windows.md
+    - Linux/Mac : tutorials/linux.md
   - Reference:
     - Index: reference/reference.md
     - Base: reference/base.md
@@ -69,7 +69,7 @@ nav:
   - Explanation:
     - Explanation : explanation/explanation.md
   - Guide:
-    - Testing : Guide/test.md
+    - Testing : guide/guide.md
 
 
 extra: