Documentation fixes (Staging and removing old stuff)

.github/workflows/documentation-build.yml

@@ -0,0 +1,51 @@
+# This pipeline
+# - builds developer documentation
+# - pushes documentation to gh-pages branch of the same repository
+#
+# Deployment is handled by pages-build-deployment bot
+#
+# For more information see: https://docs.github.com/en/pages/getting-started-with-github-pages
+
+name: Build Documentation and Push to gh-pages Branch
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on tag creation
+  push:
+    tags:
+      - 'v*'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build_documentation:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@master
+      with:
+        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
+    - name: Upgrade pip
+      run: |
+        python -m pip install --upgrade pip
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.11
+    - name: Install Pandoc, repo and dependencies
+      run: |
+        sudo apt install pandoc
+        pip install . '.[docs]'
+    - name: Build and Commit
+      uses: sphinx-notes/pages@master
+      with:
+        install_requirements: true
+        documentation_path: docs/src
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      continue-on-error: true
+      with:
+        branch: gh-pages

.gitignore

@@ -46,7 +46,7 @@ settings.ini*
 .ci/
 .idea/
 .vscode/
-ci/
+
 
 #Snap
 *.snap

README.md

@@ -12,6 +12,10 @@
 This allows **EasyReflectometry** to cover different functionality aspects within a signle, intuitive, and user-friendly interface.  
 The reflectomety packages are included with the installation so there is no need to download andn compile any additional components. 
 
+## Example of usage
+
+https://github.com/EasyScience/EasyReflectometryApp/wiki/Testing-in-Hand
+
 ## Main features
 
 **EasyReflectometry** is open source and cross-platform, with support for Windows, macOS and Linux (Ubuntu).

docs/Makefile

@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = python -msphinx
 SPHINXPROJ    = EasyReflectometry
-SOURCEDIR     = .
+SOURCEDIR     = ./src
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".