Merge pull request #238 from KULeuvenNeuromechanics/Documentation-update

Create website

Author: Lars-DHondt-KUL

.github/workflows/build_website.yml

@@ -0,0 +1,35 @@
+name: Build Sphinx website
+# Builds the website when a pull request is made. The website files 
+# can be downloaded from the github actions tab to be reviewed locally.
+
+on:
+  pull_request:
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r Documentation/requirements.txt
+
+      - name: Build Sphinx documentation
+        run: |
+          sphinx-build -M html Documentation/source/ Documentation/build/
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './Documentation/build/html'

.github/workflows/deploy.yml

@@ -0,0 +1,59 @@
+name: Deploy Sphinx to GitHub Pages
+# Builds the website and deploys the updates online when the master branch is updated.
+
+on:
+  push:
+    branches: ["master"]
+  #release:
+  #  types: [published]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r Documentation/requirements.txt
+
+      - name: Build Sphinx documentation
+        run: |
+          sphinx-build -M html Documentation/source/ Documentation/build/
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './Documentation/build/html'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -4,14 +4,18 @@
 *.sto
 *.log
 *.png
-!/Documentation/FiguresForDocumentation/*.png
 *.jpg
 *.eps
 
+!/Documentation/source/_static/*.png
+
+Documentation/build/*
 Debug/*
 opensimAD/*
 Examples/ExampleResults
 App
+
+
 Subjects/*
 !Subjects/README.md
 

Documentation/requirements.txt

@@ -0,0 +1,3 @@
+sphinx
+sphinx-autobuild
+myst-parser

Documentation/source/_static/PredSim logo.png

@@ -0,0 +1,55 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'PredSim'
+copyright = "%Y, KU Leuven Neuromechanics"
+author = "Lars D'Hondt"
+github_username = 'KULeuvenNeuromechanics'
+github_repository = 'https://github.com/KULeuvenNeuromechanics/PredSim'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['myst_parser']
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
+}
+
+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_theme_options = {
+    'fixed_sidebar': 'true', 
+    'globaltoc_maxdepth': '3',
+    'sidebar_collapse': 'false',
+    'sidebar_width': '250px',
+    'page_width': '90%',
+    'github_user': 'KULeuvenNeuromechanics',
+    'github_repo': 'PredSim',
+    #'github_banner': 'true',
+    #'github_button': 'true',
+}
+
+html_sidebars = {
+    #'**': ['navigation.html', 'searchfield.html'],
+    #'**': ['searchbox.html','globaltoc.html'],
+    '**': ['searchfield.html','globaltoc.html'],
+}
+
+html_static_path = ['_static']
+#html_logo = '_static/PredSimlogo_notext.png'
+html_logo = '_static/PredSimlogo_text.png'
+html_favicon = '_static/PredSimlogo_notext (small).png'

Documentation/source/_static/PredSimlogo_notext (Small).png

@@ -0,0 +1,21 @@
+
+
+Predictive Simulations of Locomotion
+====================================
+
+This website is currently under construction.
+Please refer to the `readme`_ and `documentation`_ on github.
+
+.. _readme: https://github.com/KULeuvenNeuromechanics/PredSim/blob/master/README.md
+.. _documentation: https://github.com/KULeuvenNeuromechanics/PredSim/tree/master/Documentation
+
+Table of Contents
+-----------------
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Useful links
+
+   GitHub <https://github.com/KULeuvenNeuromechanics/PredSim>
+   User forum <https://github.com/KULeuvenNeuromechanics/PredSim/discussions>
+