Hotfix release for new documentation

Author: damskii9992

.github/workflows/documentation-build.yml

@@ -34,15 +34,17 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: 3.11
+        python-version: 3.10.12
     - name: Install Pandoc, repo and dependencies
       run: |
         sudo apt install pandoc
+        pip install sphinx==8.1.3
         pip install . '.[dev,docs]'
     - name: Build and Commit
       uses: sphinx-notes/pages@master
       with:
-        install_requirements: true
+        install_requirements: false
+        sphinx_version: 8.1.3
         documentation_path: docs/src
     - name: Push changes
       uses: ad-m/github-push-action@master

docs/src/api/data.rst

@@ -1,4 +1,4 @@
-.. automodule:: easyreflectometry.data
+.. automodule:: easyreflectometry.data.measurement
     :members:
     :undoc-members:
     :show-inheritance:

docs/src/api/model.rst

@@ -1,4 +1,4 @@
-.. automodule:: easyreflectometry.model
+.. automodule:: easyreflectometry.model.model
     :members:
     :undoc-members:
     :show-inheritance:

docs/src/api/sample.rst

@@ -1,5 +1,4 @@
-
-.. automodule:: easyreflectometry.sample
+.. automodule:: easyreflectometry.sample.collections.sample
     :members:
     :undoc-members:
     :show-inheritance:

docs/src/conf.py

@@ -25,8 +25,7 @@
 
 import easyreflectometry
 
-# sys.path.insert(0, os.path.abspath('../src'))
-sys.path.insert(0, str(Path(__file__).resolve().parents[2] / "src"))
+sys.path.insert(0, os.path.abspath('../src'))
 
 main_root = Path(__file__).parents[2]
 sys.path.append(str(main_root))

docs/src/index.rst

@@ -5,12 +5,12 @@
    :hidden:
    :caption: Contents:
 
-   installation
-   usage
-   tutorials/tutorials
-   contributing
-   authors
-   api/api
+   installation.rst
+   usage.rst
+   tutorials/tutorials.rst
+   contributing.rst
+   authors.rst
+   api/api.rst
 
 
 Indices and tables

docs/src/tutorials/advancedfitting/advancedfitting.rst

@@ -0,0 +1,9 @@
+Advanced Fitting
+================
+
+These are advanced fitting examples using the :py:mod:`easyreflectometry` library, to get an understanding of the possibilities.
+
+.. toctree:: 
+   :maxdepth: 1
+   
+   multi_contrast.ipynb

docs/src/tutorials/advancedfitting/multi_contrast.ipynb

@@ -1,5 +1,5 @@
 Creating multilayers and surfactant layers
-==========
+===========================================
 
 :py:mod:`easyreflectometry` is designed to be used with a broad range of different assemblies.  
 Assemblies are collective layers behaving as a single object, for example, a multilayer or a surfactant layer.

docs/src/tutorials/basic/assemblies_library.rst

@@ -1,12 +1,13 @@
 Basic
-======
+=====
 
 The :py:mod:`easyreflectometry` package is focused on making easy to use functionality for specific modelling approaches. 
 In order to achieve this, we have a sample library with different functionality. 
 
 .. toctree:: 
    :maxdepth: 1
-
+   
+   model
    material_library
    layer_library
    assemblies_library