upb-lea · gituser789 · May 1, 2024 · Apr 30, 2024 · Apr 30, 2024 · Apr 30, 2024
diff --git a/.github/workflows/develop.yml b/.github/workflows/develop.yml
@@ -83,5 +83,5 @@ jobs:
           pip install sphinx sphinx-multiversion sphinx_rtd_theme sphinxcontrib-email
           pwd
           ls
-          cd documentation/
+          cd docs/
           make html
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -83,5 +83,5 @@ jobs:
           pip install sphinx sphinx-multiversion sphinx_rtd_theme sphinxcontrib-email
           pwd
           ls
-          cd documentation/
+          cd docs/
           make html
diff --git a/.github/workflows/sphinx_render_docs.yml b/.github/workflows/sphinx_render_docs.yml
@@ -0,0 +1,29 @@
+name: "Sphinx: Render docs"
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install sphinx and build documentation with sphinx
+      run: |
+        pip install sphinx sphinx-multiversion sphinx_rtd_theme sphinxcontrib-email
+    - name: Build HTML
+      uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "docs/"
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: html-docs
+        path: docs/build/html/
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/main'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/build/html
diff --git a/documentation/Makefile → docs/Makefile b/documentation/Makefile → docs/Makefile
diff --git a/documentation/README.txt → docs/README.txt b/documentation/README.txt → docs/README.txt
diff --git a/documentation/images/FEMMT_Screenshot.png → docs/images/FEMMT_Screenshot.png b/documentation/images/FEMMT_Screenshot.png → docs/images/FEMMT_Screenshot.png
diff --git a/...entation/images/counting_arrow_system.png → docs/images/counting_arrow_system.png b/...entation/images/counting_arrow_system.png → docs/images/counting_arrow_system.png
diff --git a/...entation/images/counting_arrow_system.svg → docs/images/counting_arrow_system.svg b/...entation/images/counting_arrow_system.svg → docs/images/counting_arrow_system.svg
diff --git a/documentation/images/femmt.png → docs/images/femmt.png b/documentation/images/femmt.png → docs/images/femmt.png
diff --git a/documentation/images/femmt.svg → docs/images/femmt.svg b/documentation/images/femmt.svg → docs/images/femmt.svg
diff --git a/...mentation/images/femmt_gui_definition.png → docs/images/femmt_gui_definition.png b/...mentation/images/femmt_gui_definition.png → docs/images/femmt_gui_definition.png
diff --git a/documentation/images/geometry_air_gap.png → docs/images/geometry_air_gap.png b/documentation/images/geometry_air_gap.png → docs/images/geometry_air_gap.png
diff --git a/documentation/images/geometry_air_gap.svg → docs/images/geometry_air_gap.svg b/documentation/images/geometry_air_gap.svg → docs/images/geometry_air_gap.svg
diff --git a/documentation/images/geometry_core.png → docs/images/geometry_core.png b/documentation/images/geometry_core.png → docs/images/geometry_core.png
diff --git a/documentation/images/geometry_core.svg → docs/images/geometry_core.svg b/documentation/images/geometry_core.svg → docs/images/geometry_core.svg
diff --git a/.../images/geometry_core_developer_notes.png → .../images/geometry_core_developer_notes.png b/.../images/geometry_core_developer_notes.png → .../images/geometry_core_developer_notes.png
diff --git a/.../images/geometry_core_developer_notes.svg → .../images/geometry_core_developer_notes.svg b/.../images/geometry_core_developer_notes.svg → .../images/geometry_core_developer_notes.svg
diff --git a/...mages/geometry_core_naming_convention.png → ...mages/geometry_core_naming_convention.png b/...mages/geometry_core_naming_convention.png → ...mages/geometry_core_naming_convention.png
diff --git a/...mages/geometry_core_naming_convention.svg → ...mages/geometry_core_naming_convention.svg b/...mages/geometry_core_naming_convention.svg → ...mages/geometry_core_naming_convention.svg
diff --git a/documentation/images/geometry_insulation.png → docs/images/geometry_insulation.png b/documentation/images/geometry_insulation.png → docs/images/geometry_insulation.png
diff --git a/documentation/images/geometry_insulation.svg → docs/images/geometry_insulation.svg b/documentation/images/geometry_insulation.svg → docs/images/geometry_insulation.svg
diff --git a/documentation/images/geometry_thermal.png → docs/images/geometry_thermal.png b/documentation/images/geometry_thermal.png → docs/images/geometry_thermal.png
diff --git a/documentation/images/geometry_thermal.svg → docs/images/geometry_thermal.svg b/documentation/images/geometry_thermal.svg → docs/images/geometry_thermal.svg
diff --git a/documentation/images/geometry_translated.png → docs/images/geometry_translated.png b/documentation/images/geometry_translated.png → docs/images/geometry_translated.png
diff --git a/documentation/images/geometry_translated.svg → docs/images/geometry_translated.svg b/documentation/images/geometry_translated.svg → docs/images/geometry_translated.svg
diff --git a/...ation/images/geometry_winding_windows.png → docs/images/geometry_winding_windows.png b/...ation/images/geometry_winding_windows.png → docs/images/geometry_winding_windows.png
diff --git a/...ation/images/geometry_winding_windows.svg → docs/images/geometry_winding_windows.svg b/...ation/images/geometry_winding_windows.svg → docs/images/geometry_winding_windows.svg
diff --git a/documentation/images/msh_panel.png → docs/images/msh_panel.png b/documentation/images/msh_panel.png → docs/images/msh_panel.png
diff --git a/documentation/images/msh_simulation.png → docs/images/msh_simulation.png b/documentation/images/msh_simulation.png → docs/images/msh_simulation.png
diff --git a/...mages/pycharm_configuration_pro_files.png → ...mages/pycharm_configuration_pro_files.png b/...mages/pycharm_configuration_pro_files.png → ...mages/pycharm_configuration_pro_files.png
diff --git a/...mages/pycharm_configuration_pro_files.svg → ...mages/pycharm_configuration_pro_files.svg b/...mages/pycharm_configuration_pro_files.svg → ...mages/pycharm_configuration_pro_files.svg
diff --git a/...ation/images/user_guide_example_model.png → docs/images/user_guide_example_model.png b/...ation/images/user_guide_example_model.png → docs/images/user_guide_example_model.png
diff --git a/.../images/user_guide_example_simulation.png → .../images/user_guide_example_simulation.png b/.../images/user_guide_example_simulation.png → .../images/user_guide_example_simulation.png
diff --git a/...user_guide_example_thermal_simulation.png → ...user_guide_example_thermal_simulation.png b/...user_guide_example_thermal_simulation.png → ...user_guide_example_thermal_simulation.png
diff --git a/...pes/Interleaved_HorizontalAlternating.png → ...pes/Interleaved_HorizontalAlternating.png b/...pes/Interleaved_HorizontalAlternating.png → ...pes/Interleaved_HorizontalAlternating.png
diff --git a/...Interleaved_VerticalStacked_hexagonal.png → ...Interleaved_VerticalStacked_hexagonal.png b/...Interleaved_VerticalStacked_hexagonal.png → ...Interleaved_VerticalStacked_hexagonal.png
diff --git a/...es/Interleaved_VerticalStacked_square.png → ...es/Interleaved_VerticalStacked_square.png b/...es/Interleaved_VerticalStacked_square.png → ...es/Interleaved_VerticalStacked_square.png
diff --git a/...s/winding_types/Single_FoilHorizontal.png → ...s/winding_types/Single_FoilHorizontal.png b/...s/winding_types/Single_FoilHorizontal.png → ...s/winding_types/Single_FoilHorizontal.png
diff --git a/...s/Single_FoilVertical_fixed_thickness.png → ...s/Single_FoilVertical_fixed_thickness.png b/...s/Single_FoilVertical_fixed_thickness.png → ...s/Single_FoilVertical_fixed_thickness.png
diff --git a/...types/Single_FoilVertical_interpolate.png → ...types/Single_FoilVertical_interpolate.png b/...types/Single_FoilVertical_interpolate.png → ...types/Single_FoilVertical_interpolate.png
diff --git a/...tion/images/winding_types/Single_Full.png → docs/images/winding_types/Single_Full.png b/...tion/images/winding_types/Single_Full.png → docs/images/winding_types/Single_Full.png
diff --git a/...images/winding_types/Single_Hexagonal.png → ...images/winding_types/Single_Hexagonal.png b/...images/winding_types/Single_Hexagonal.png → ...images/winding_types/Single_Hexagonal.png
diff --git a/...on/images/winding_types/Single_Square.png → docs/images/winding_types/Single_Square.png b/...on/images/winding_types/Single_Square.png → docs/images/winding_types/Single_Square.png
diff --git a/.../winding_types/Single_SquareFullWidth.png → .../winding_types/Single_SquareFullWidth.png b/.../winding_types/Single_SquareFullWidth.png → .../winding_types/Single_SquareFullWidth.png
diff --git a/documentation/make.bat → docs/make.bat b/documentation/make.bat → docs/make.bat
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+sphinx-multiversion
+sphinx_rtd_theme
+sphinxcontrib-email
diff --git a/documentation/source/conf.py → docs/source/conf.py b/documentation/source/conf.py → docs/source/conf.py
@@ -31,7 +31,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 sys.path.insert(0, os.path.abspath('_extensions'))
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.todo', 'sphinx_multiversion']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.todo']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates/']

diff --git a/documentation/source/developer_notes.rst → docs/source/developer_notes.rst b/documentation/source/developer_notes.rst → docs/source/developer_notes.rst
diff --git a/documentation/source/index.rst → docs/source/index.rst b/documentation/source/index.rst → docs/source/index.rst
diff --git a/documentation/source/intro.rst → docs/source/intro.rst b/documentation/source/intro.rst → docs/source/intro.rst
diff --git a/documentation/source/introduction.rst → docs/source/introduction.rst b/documentation/source/introduction.rst → docs/source/introduction.rst
diff --git a/...tion/source/user_guide_model_creation.rst → docs/source/user_guide_model_creation.rst b/...tion/source/user_guide_model_creation.rst → docs/source/user_guide_model_creation.rst
diff --git a/documentation/source/winding_types.rst → docs/source/winding_types.rst b/documentation/source/winding_types.rst → docs/source/winding_types.rst