first documentation

.github/workflows/documentation.yml

@@ -0,0 +1,25 @@
+name: Build Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Julia
+        uses: julia-actions/setup-julia@v1
+        with:
+          version: '1.8'
+
+      - name: Install dependencies
+        run: |
+          julia --project=docs -e 'using Pkg; Pkg.instantiate()'
+
+      - name: Build documentation
+        run: |
+          julia --project=docs docs/make.jl

.readthedocs.yaml

@@ -0,0 +1,23 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt
+

docs/Project.toml

@@ -0,0 +1,4 @@
+name = "StressifyDocs"
+version = "0.1.0"
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/index.md

@@ -0,0 +1,6 @@
+# Stressify.jl
+
+Welcome to the **Stressify.jl** documentation!
+
+- **Guide**: Learn how to use Stressify.jl effectively.
+- **API Reference**: Explore all public functions and modules.

docs/make.jl

@@ -0,0 +1,11 @@
+using Documenter
+using Stressify
+
+makedocs(
+    sitename = "Stressify.jl",
+    pages = [
+        "Home" => "index.md",
+        "Guide" => "src/guide.md",
+        "API" => "src/api.md"
+    ]
+)

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx==4.5.0
+sphinx-rtd-theme==1.0.0