docs: add documentation (#286)

* Created New documentation

Added a source folder with new documentation files

* Create sphinx-docs.yml

Created and configured the workflow for the SACRO Viewer documentation to automatically build using Sphinx.

* Update sphinx-docs.yml

* Included more content and worked on the userguide

1. Included More content
2. Includes more content in the introduction.rst, index.rst.
3. Added more content on User guide
4. Included a log.
5. Developer guide

* Fixed some content errors

1. Added more content on the developer's guide
2. Added Sacro logo
3. Fix formating issues
4. Removed FAQ and help page

* Update architecture.rst

* Re-push to reflect changes

1. Added more content on the developer's guide
2. Added Sacro logo
3. Fix formating issues
4. Removed FAQ and help page

* cleaned up some of the rst files, fixed the user_guide. Added more con tent

* Delete docs/build directory

* Add responsive styles and card component styles

Author: JessUWE

.github/workflows/sphinx-docs.yml

@@ -0,0 +1,33 @@
+---
+name: sphinx build
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+      - '**.cff'
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Install documentation dependencies
+        run: |
+          pip install sphinx>=5.0 sphinx-issues sphinx-prompt pydata-sphinx-theme sphinx-design
+          sphinx-build ./docs/source ./docs/_build/html/
+
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_build/html/
+          force_orphan: true
+...

docs/source/_static/SACRO_Logo_final.png

@@ -0,0 +1,89 @@
+
+.sd-card {
+    transition: transform 0.2s ease-in-out;
+    border-radius: 0.5rem;
+    overflow: hidden;
+    word-wrap: break-word;
+}
+
+.sd-card:hover {
+    transform: translateY(-5px);
+}
+
+.sd-card-title {
+    font-weight: 600;
+    word-wrap: break-word;
+    overflow-wrap: break-word;
+}
+
+.sd-card-body {
+    overflow: hidden;
+}
+
+[data-theme="light"] .sd-card-title {
+    color: #212529 !important;
+}
+
+[data-theme="dark"] .sd-card-title {
+    color: #fff !important;
+}
+
+@media (prefers-color-scheme: light) {
+    .sd-card-title {
+        color: #212529 !important;
+    }
+}
+
+@media (prefers-color-scheme: dark) {
+    .sd-card-title {
+        color: #fff !important;
+    }
+}
+
+.sd-card-footer {
+    border-top: 1px solid rgba(0,0,0,0.1);
+    padding-top: 0.5rem;
+    word-wrap: break-word;
+}
+
+
+@media (max-width: 992px) {
+    .sd-container-fluid .sd-row {
+        flex-direction: column;
+    }
+    
+    .sd-col {
+        flex: 0 0 100% !important;
+        max-width: 100% !important;
+        width: 100% !important;
+    }
+    
+    .sd-card {
+        margin-bottom: 1rem;
+        width: 100% !important;
+    }
+}
+
+@media (max-width: 1280px) {
+    .navbar-brand {
+        white-space: nowrap;
+        overflow: hidden;
+        text-overflow: ellipsis;
+        max-width: 120px;
+    }
+    
+    .navbar-nav {
+        font-size: 0.85rem;
+    }
+    
+    .navbar-nav .nav-link {
+        padding-left: 0.5rem;
+        padding-right: 0.5rem;
+    }
+}
+
+@media (max-width: 992px) {
+    .navbar-brand {
+        max-width: 100px;
+    }
+}

docs/source/_static/css/custom.css

@@ -0,0 +1,73 @@
+"""Configuration file for the Sphinx documentation builder."""
+
+# -- Path setup --------------------------------------------------------------
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../../"))
+
+# -- Project information -----------------------------------------------------
+
+project = "SACRO Viewer"
+copyright = "2025, GRAIMATTER and SACRO Project Team"
+author = "GRAIMATTER and SACRO Project Team"
+release = "0.1.0"
+
+# -- General configuration ---------------------------------------------------
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.imgconverter",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "sphinx_issues",
+    "sphinx_prompt",
+    "pydata_sphinx_theme",
+    "sphinx_design",
+]
+
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+
+html_theme = "pydata_sphinx_theme"
+html_theme_options = {"navigation_depth": 2}
+
+html_static_path = ["_static"]
+html_css_files = [
+    "css/custom.css",
+]
+
+# -- -------------------------------------------------------------------------
+
+autodoc_default_options = {
+    "members": True,
+    "inherited-members": True,
+    "member-order": "groupwise",
+    "special-members": "__init__",
+    "undoc-members": True,
+    "exclude-members": "__weakref__",
+}
+
+# Napoleon settings for Google/NumPy style docstrings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+
+# Intersphinx mapping for external documentation
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "django": ("https://docs.djangoproject.com/en/stable/", "https://docs.djangoproject.com/en/stable/_objects/"),
+}