Add MkDocs documentation files and update configuration for site stru…

…cture
sergiudm · Dec 9, 2024 · 926c4ad · 926c4ad
1 parent d56cd8c
commit 926c4ad
Show file tree

Hide file tree

Showing 35 changed files with 2 additions and 3 deletions.
diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
@@ -28,15 +28,15 @@ jobs:
         run: pip install mkdocs mkdocs-dracula-theme
 
       - name: Build MkDocs site
-        run: mkdocs build --config-file docs/mkdocs.yml --site-dir site
+        run: mkdocs build --config-file site_docs/mkdocs.yml --site-dir site_docs
 
       - name: Setup Pages
         uses: actions/configure-pages@v3
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
         with:
-          path: 'site'
+          path: 'site_docs'
 
       - name: Deploy to GitHub Pages
         id: deployment

diff --git a/docs/docs/about.md → site_docs/docs/about.md b/docs/docs/about.md → site_docs/docs/about.md
diff --git a/docs/docs/getting-started.md → site_docs/docs/getting-started.md b/docs/docs/getting-started.md → site_docs/docs/getting-started.md
diff --git a/docs/docs/index.md → site_docs/docs/index.md b/docs/docs/index.md → site_docs/docs/index.md
diff --git a/docs/docs/plugins-tutorial.md → site_docs/docs/plugins-tutorial.md b/docs/docs/plugins-tutorial.md → site_docs/docs/plugins-tutorial.md
diff --git a/docs/docs/release-notes.md → site_docs/docs/release-notes.md b/docs/docs/release-notes.md → site_docs/docs/release-notes.md
diff --git a/docs/docs/user-guide.md → site_docs/docs/user-guide.md b/docs/docs/user-guide.md → site_docs/docs/user-guide.md
diff --git a/docs/mkdocs.yml → site_docs/mkdocs.yml b/docs/mkdocs.yml → site_docs/mkdocs.yml
@@ -1,5 +1,4 @@
 site_name: DETECTIVE
-docs_dir: docs
 nav: 
   - Home: index.md
   - Getting Started: getting-started.md

diff --git a/docs/site/404.html → site_docs/site/404.html b/docs/site/404.html → site_docs/site/404.html
diff --git a/docs/site/about/index.html → site_docs/site/about/index.html b/docs/site/about/index.html → site_docs/site/about/index.html
diff --git a/docs/site/assets/css/bootstrap.min.css → site_docs/site/assets/css/bootstrap.min.css b/docs/site/assets/css/bootstrap.min.css → site_docs/site/assets/css/bootstrap.min.css
diff --git a/docs/site/assets/css/bootstrap.min.css.map → ...ocs/site/assets/css/bootstrap.min.css.map b/docs/site/assets/css/bootstrap.min.css.map → ...ocs/site/assets/css/bootstrap.min.css.map
diff --git a/...site/assets/css/darcula-highlight.min.css → ...site/assets/css/darcula-highlight.min.css b/...site/assets/css/darcula-highlight.min.css → ...site/assets/css/darcula-highlight.min.css
diff --git a/docs/site/assets/css/dracula-ui.css.map → site_docs/site/assets/css/dracula-ui.css.map b/docs/site/assets/css/dracula-ui.css.map → site_docs/site/assets/css/dracula-ui.css.map
diff --git a/docs/site/assets/css/dracula-ui.min.css → site_docs/site/assets/css/dracula-ui.min.css b/docs/site/assets/css/dracula-ui.min.css → site_docs/site/assets/css/dracula-ui.min.css
diff --git a/docs/site/assets/css/mkdocs.min.css → site_docs/site/assets/css/mkdocs.min.css b/docs/site/assets/css/mkdocs.min.css → site_docs/site/assets/css/mkdocs.min.css
diff --git a/docs/site/assets/img/dracula.png → site_docs/site/assets/img/dracula.png b/docs/site/assets/img/dracula.png → site_docs/site/assets/img/dracula.png
diff --git a/docs/site/assets/img/dracula.svg → site_docs/site/assets/img/dracula.svg b/docs/site/assets/img/dracula.svg → site_docs/site/assets/img/dracula.svg
diff --git a/docs/site/assets/img/favicon.ico → site_docs/site/assets/img/favicon.ico b/docs/site/assets/img/favicon.ico → site_docs/site/assets/img/favicon.ico
diff --git a/docs/site/assets/js/bootstrap.bundle.min.js → ...cs/site/assets/js/bootstrap.bundle.min.js b/docs/site/assets/js/bootstrap.bundle.min.js → ...cs/site/assets/js/bootstrap.bundle.min.js
diff --git a/...ite/assets/js/bootstrap.bundle.min.js.map → ...ite/assets/js/bootstrap.bundle.min.js.map b/...ite/assets/js/bootstrap.bundle.min.js.map → ...ite/assets/js/bootstrap.bundle.min.js.map
diff --git a/docs/site/assets/js/jquery-3.3.1.slim.min.js → ...s/site/assets/js/jquery-3.3.1.slim.min.js b/docs/site/assets/js/jquery-3.3.1.slim.min.js → ...s/site/assets/js/jquery-3.3.1.slim.min.js
diff --git a/docs/site/assets/js/mkdocs.js → site_docs/site/assets/js/mkdocs.js b/docs/site/assets/js/mkdocs.js → site_docs/site/assets/js/mkdocs.js
diff --git a/docs/site/getting-started/index.html → site_docs/site/getting-started/index.html b/docs/site/getting-started/index.html → site_docs/site/getting-started/index.html
diff --git a/docs/site/index.html → site_docs/site/index.html b/docs/site/index.html → site_docs/site/index.html
diff --git a/docs/site/plugins-tutorial/index.html → site_docs/site/plugins-tutorial/index.html b/docs/site/plugins-tutorial/index.html → site_docs/site/plugins-tutorial/index.html
diff --git a/docs/site/release-notes/index.html → site_docs/site/release-notes/index.html b/docs/site/release-notes/index.html → site_docs/site/release-notes/index.html
diff --git a/docs/site/search.html → site_docs/site/search.html b/docs/site/search.html → site_docs/site/search.html
diff --git a/docs/site/search/lunr.js → site_docs/site/search/lunr.js b/docs/site/search/lunr.js → site_docs/site/search/lunr.js
diff --git a/docs/site/search/main.js → site_docs/site/search/main.js b/docs/site/search/main.js → site_docs/site/search/main.js
diff --git a/docs/site/search/search_index.json → site_docs/site/search/search_index.json b/docs/site/search/search_index.json → site_docs/site/search/search_index.json
diff --git a/docs/site/search/worker.js → site_docs/site/search/worker.js b/docs/site/search/worker.js → site_docs/site/search/worker.js
diff --git a/docs/site/sitemap.xml → site_docs/site/sitemap.xml b/docs/site/sitemap.xml → site_docs/site/sitemap.xml
diff --git a/docs/site/sitemap.xml.gz → site_docs/site/sitemap.xml.gz b/docs/site/sitemap.xml.gz → site_docs/site/sitemap.xml.gz
diff --git a/docs/site/user-guide/index.html → site_docs/site/user-guide/index.html b/docs/site/user-guide/index.html → site_docs/site/user-guide/index.html