Merge branch 'main' into joss

Author: RemDelaporteMathurin

.github/workflows/build-deploy-docs.yml

@@ -0,0 +1,58 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Build and deploy docs
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # 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:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      PUBLISH_DIR: ./_build
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx-book-theme
+
+      - name: Sphinx build
+        run: |
+          sphinx-build docs _build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ${{ env.PUBLISH_DIR }}
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/conf.py

@@ -6,7 +6,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "pathview"
+project = "PathView"
 copyright = "2025, Tasnim Zulfiqar, James Dark, Remi Delaporte-Mathurin"
 author = "Tasnim Zulfiqar, James Dark, Remi Delaporte-Mathurin"
 
@@ -24,3 +24,37 @@
 
 html_theme = "sphinx_book_theme"
 html_static_path = ["_static"]
+
+html_theme_options = {
+    "repository_url": "https://github.com/festim-dev/PathView",
+    "use_repository_button": True,
+    "use_edit_page_button": True,
+    "repository_branch": "main",
+    "path_to_docs": "./docs",
+    "icon_links": [
+        {
+            "name": "GitHub Discussions",
+            "url": "https://github.com/festim-dev/pathview/discussions",
+            "icon": "fa-solid fa-comments",
+        },
+        {
+            "name": "Slack",
+            "url": "https://join.slack.com/t/festim-dev/shared_invite/zt-246hw8d6o-htWASLsbdosUo_2nRKCf9g",
+            "icon": "fa-brands fa-slack",
+        },
+    ],
+    "article_header_end": [
+        "navbar-icon-links",
+        "article-header-buttons",
+    ],
+}
+
+html_sidebars = {
+    "**": [
+        "navbar-logo",
+        "search-button-field",
+        "sbt-sidebar-nav",
+    ],
+}
+
+html_title = "PathView Documentation"

docs/contributing.rst

@@ -0,0 +1,53 @@
+===============================
+Contributing Guide
+===============================
+
+Code of Conduct
+----------------
+
+Please read our `Code of Conduct <../CODE_OF_CONDUCT.md>`_.
+
+Contributing Guidelines
+-----------------------
+
+**Getting Started**
+   1. Fork the repository
+   2. Create a feature branch (``git checkout -b awesome-feature``)
+   3. Make your changes
+   4. Add tests for new functionality if needed
+   5. Ensure all tests pass
+   6. Submit a pull request
+
+**Development Standards**
+   - Follow existing code style and conventions
+   - Write clear, descriptive commit messages
+   - Include tests for new features
+   - Update documentation as needed
+   - Ensure backwards compatibility when possible
+
+**Types of Contributions**
+   - 🐛 Bug reports and fixes
+   - ✨ New features and enhancements
+   - 📚 Documentation improvements
+   - 🎨 UI/UX improvements
+   - 🧪 Test coverage improvements
+
+Communication Channels
+-----------------------
+
+**GitHub Discussions**
+    - General questions and help
+    - Feature requests and ideas
+    - Community showcases
+    - Development discussions
+
+**Issues**
+    - Bug reports
+    - Specific feature requests
+    - Documentation issues
+
+**Pull Requests**
+   - Provide clear description of changes
+   - Reference related issues
+   - Include screenshots for UI changes
+   - Ensure CI checks pass