Merge pull request #44 from TUB-DVG/gh-pages2

Gh pages2
TUB-DVG · Sep 4, 2024 · f0abd7c · f0abd7c
2 parents f1d104b + a4516eb
commit f0abd7c
Show file tree

Hide file tree

Showing 13 changed files with 61 additions and 102 deletions.
diff --git a/.github/workflows/sphinx-pages b/.github/workflows/sphinx-pages
diff --git a/.github/workflows/sphinx-pages.yml b/.github/workflows/sphinx-pages.yml
@@ -0,0 +1,26 @@
+name: Build and Deploy
+on:
+  push:
+    branches:
+      - main  # Trigger only on pushes to the main branch
+permissions:
+  contents: write
+jobs:
+  build-and-deploy:
+    concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme myst_parser sphinxcontrib-mermaid
+      - name: Sphinx build
+        run: |
+          sphinx-build webcentral/doc/06_sphinx/source build      
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: build # The folder the action should deploy.
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
diff --git a/webcentral/doc/06_sphinx/source/conf.py b/webcentral/doc/06_sphinx/source/conf.py
@@ -29,16 +29,17 @@
 # django.setup()
 extensions = [
     # "sphinx.ext.autodoc",
+    "sphinx.ext.githubpages",
     "myst_parser",
     "sphinxcontrib.mermaid",
     "sphinx.ext.napoleon",
 ]
 
-templates_path = ["_templates"]
+templates_path = ["templates"]
 exclude_patterns = []
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "alabaster"
-html_static_path = ["_static"]
+html_static_path = ["static"]
diff --git a/...06_sphinx/source/contentSecurityPolicy.md → webcentral/doc/06_sphinx/source/dev/csp.md b/...06_sphinx/source/contentSecurityPolicy.md → webcentral/doc/06_sphinx/source/dev/csp.md
diff --git a/...tral/doc/06_sphinx/source/loadProfiles.md → ...doc/06_sphinx/source/dev/load_profiles.md b/...tral/doc/06_sphinx/source/loadProfiles.md → ...doc/06_sphinx/source/dev/load_profiles.md
diff --git a/...entral/doc/06_sphinx/source/plotlyApps.md → ...l/doc/06_sphinx/source/dev/plotly_apps.md b/...entral/doc/06_sphinx/source/plotlyApps.md → ...l/doc/06_sphinx/source/dev/plotly_apps.md
diff --git a/...l/doc/06_sphinx/source/save_page_views.md → ...c/06_sphinx/source/dev/save_page_views.md b/...l/doc/06_sphinx/source/save_page_views.md → ...c/06_sphinx/source/dev/save_page_views.md
diff --git a/.../06_sphinx/source/static_code_analysis.md → ...sphinx/source/dev/static_code_analysis.md b/.../06_sphinx/source/static_code_analysis.md → ...sphinx/source/dev/static_code_analysis.md
diff --git a/webcentral/doc/06_sphinx/source/useCases.md → ...ral/doc/06_sphinx/source/dev/use_cases.md b/webcentral/doc/06_sphinx/source/useCases.md → ...ral/doc/06_sphinx/source/dev/use_cases.md
diff --git a/...entral/doc/06_sphinx/source/migrations.md → ...oc/06_sphinx/source/general/migrations.md b/...entral/doc/06_sphinx/source/migrations.md → ...oc/06_sphinx/source/general/migrations.md
diff --git a/...entral/doc/06_sphinx/source/production.md → ...oc/06_sphinx/source/general/production.md b/...entral/doc/06_sphinx/source/production.md → ...oc/06_sphinx/source/general/production.md
diff --git a/webcentral/doc/06_sphinx/source/index.rst b/webcentral/doc/06_sphinx/source/index.rst
@@ -9,26 +9,50 @@ Welcome to webcentral's documentation!
 Here you can find the documentation of the page source. The source code can be found on Github (insert link).
 If you would like to do some development or host the Wissensplattform, please find information on the get started (insert link) page
 
+End user guide
+==============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   general/getting_started
+   general/data_import
+   general/migrations
+   general/production
+
+Develop guide
+=============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   dev/style_guide
+   dev/static_code_analysis
+   dev/pyproject_toml
+   dev/testing
+   dev/load_profiles
+   dev/plotly_apps
+   dev/csp
+   dev/use_cases
+   dev/save_page_views
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   quickstart
-   migrations
    installtion_basics
-   pyproject_toml
-   contentSecurityPolicy
    dataImportDjango
    insertLinksInDatabase
    templateStructure
    translation
-   loadProfiles
-   plotlyApps
-   useCases
    listing_pages
    testing
-   production
+
+
 
+
 Indices and tables
 ==================