Merge pull request #16 from mlehujeur/main

Pages documentation 1/2
Universite-Gustave-Eiffel · Dec 21, 2023 · 3676d72 · 3676d72
2 parents 9edecbc + d1f1c88
commit 3676d72
Show file tree

Hide file tree

Showing 29 changed files with 4 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -60,7 +60,8 @@ coverage.xml
 .hypothesis/
 
 # Sphinx documentation
-docs/_build/
+# Ignore the html pages only in the main branch, TODO: un-ignore in the pages branch
+/docs/
 
 # PyBuilder
 target/
@@ -74,3 +75,4 @@ target/
 
 .code-workspace
 /examples/protonerrors.log
+
diff --git a/docs/ElastodynamiCSx.html b/docs/ElastodynamiCSx.html
diff --git a/docs/Makefile → docsrc/Makefile b/docs/Makefile → docsrc/Makefile
diff --git a/docs/api/api_index.rst → docsrc/api/api_index.rst b/docs/api/api_index.rst → docsrc/api/api_index.rst
diff --git a/docs/api/elastodynamicsx.pde.materials.rst → docsrc/api/elastodynamicsx.pde.materials.rst b/docs/api/elastodynamicsx.pde.materials.rst → docsrc/api/elastodynamicsx.pde.materials.rst
diff --git a/docs/api/elastodynamicsx.pde.rst → docsrc/api/elastodynamicsx.pde.rst b/docs/api/elastodynamicsx.pde.rst → docsrc/api/elastodynamicsx.pde.rst
diff --git a/docs/api/elastodynamicsx.pde.timeschemes.rst → ...c/api/elastodynamicsx.pde.timeschemes.rst b/docs/api/elastodynamicsx.pde.timeschemes.rst → ...c/api/elastodynamicsx.pde.timeschemes.rst
diff --git a/docs/api/elastodynamicsx.plot.rst → docsrc/api/elastodynamicsx.plot.rst b/docs/api/elastodynamicsx.plot.rst → docsrc/api/elastodynamicsx.plot.rst
diff --git a/docs/api/elastodynamicsx.solutions.rst → docsrc/api/elastodynamicsx.solutions.rst b/docs/api/elastodynamicsx.solutions.rst → docsrc/api/elastodynamicsx.solutions.rst
diff --git a/...i/elastodynamicsx.solvers.eigensolver.rst → ...i/elastodynamicsx.solvers.eigensolver.rst b/...i/elastodynamicsx.solvers.eigensolver.rst → ...i/elastodynamicsx.solvers.eigensolver.rst
diff --git a/...astodynamicsx.solvers.frequencydomain.rst → ...astodynamicsx.solvers.frequencydomain.rst b/...astodynamicsx.solvers.frequencydomain.rst → ...astodynamicsx.solvers.frequencydomain.rst
diff --git a/docs/api/elastodynamicsx.solvers.rst → docsrc/api/elastodynamicsx.solvers.rst b/docs/api/elastodynamicsx.solvers.rst → docsrc/api/elastodynamicsx.solvers.rst
diff --git a/...i/elastodynamicsx.solvers.timestepper.rst → ...i/elastodynamicsx.solvers.timestepper.rst b/...i/elastodynamicsx.solvers.timestepper.rst → ...i/elastodynamicsx.solvers.timestepper.rst
diff --git a/docs/api/elastodynamicsx.utils.rst → docsrc/api/elastodynamicsx.utils.rst b/docs/api/elastodynamicsx.utils.rst → docsrc/api/elastodynamicsx.utils.rst
diff --git a/docs/conf.py → docsrc/conf.py b/docs/conf.py → docsrc/conf.py
diff --git a/docs/demos/examples_index.rst → docsrc/demos/examples_index.rst b/docs/demos/examples_index.rst → docsrc/demos/examples_index.rst
diff --git a/docs/demos/examples_section1.rst → docsrc/demos/examples_section1.rst b/docs/demos/examples_section1.rst → docsrc/demos/examples_section1.rst
diff --git a/docs/demos/examples_section1_files.rst → docsrc/demos/examples_section1_files.rst b/docs/demos/examples_section1_files.rst → docsrc/demos/examples_section1_files.rst
diff --git a/docs/demos/examples_section2.rst → docsrc/demos/examples_section2.rst b/docs/demos/examples_section2.rst → docsrc/demos/examples_section2.rst
diff --git a/docs/demos/examples_section2_files.rst → docsrc/demos/examples_section2_files.rst b/docs/demos/examples_section2_files.rst → docsrc/demos/examples_section2_files.rst
diff --git a/docs/demos/examples_section3.rst → docsrc/demos/examples_section3.rst b/docs/demos/examples_section3.rst → docsrc/demos/examples_section3.rst
diff --git a/docs/demos/examples_section3_files.rst → docsrc/demos/examples_section3_files.rst b/docs/demos/examples_section3_files.rst → docsrc/demos/examples_section3_files.rst
diff --git a/docs/demos/examples_section4.rst → docsrc/demos/examples_section4.rst b/docs/demos/examples_section4.rst → docsrc/demos/examples_section4.rst
diff --git a/docs/demos/examples_section4_files.rst → docsrc/demos/examples_section4_files.rst b/docs/demos/examples_section4_files.rst → docsrc/demos/examples_section4_files.rst
diff --git a/docs/demos/examples_section5.rst → docsrc/demos/examples_section5.rst b/docs/demos/examples_section5.rst → docsrc/demos/examples_section5.rst
diff --git a/docs/index.rst → docsrc/index.rst b/docs/index.rst → docsrc/index.rst
diff --git a/docs/make.bat → docsrc/make.bat b/docs/make.bat → docsrc/make.bat
diff --git a/docs/readme_link.md → docsrc/readme_link.md b/docs/readme_link.md → docsrc/readme_link.md
diff --git a/setup.py b/setup.py
@@ -19,7 +19,7 @@ def finalize_options(self):
     def run(self):
         """The command to run when users invoke python setup.py doc"""
         subprocess.run(
-            ['sphinx-build docs/ docs/_build'], shell=True)
+            ['sphinx-build docsrc docs'], shell=True)
 
 
 setuptools.setup(