From 7f1f9422886a09f5c7cd9abfa198b0d78f5643d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Martins=20Filho?= Date: Sun, 8 Dec 2024 22:10:44 -0300 Subject: [PATCH] first documentation --- .github/workflows/documentation.yml | 25 +++++++++++++++++++++++++ .readthedocs.yaml | 23 +++++++++++++++++++++++ docs/Project.toml | 4 ++++ docs/index.md | 6 ++++++ docs/make.jl | 11 +++++++++++ docs/requirements.txt | 2 ++ docs/src/api.md | 0 docs/src/guide.md | 0 8 files changed, 71 insertions(+) create mode 100644 .github/workflows/documentation.yml create mode 100644 .readthedocs.yaml create mode 100644 docs/Project.toml create mode 100644 docs/index.md create mode 100644 docs/make.jl create mode 100644 docs/requirements.txt create mode 100644 docs/src/api.md create mode 100644 docs/src/guide.md diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..acbb1ca --- /dev/null +++ b/.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 diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..d038dfa --- /dev/null +++ b/.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 + \ No newline at end of file diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..13fef71 --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,4 @@ +name = "StressifyDocs" +version = "0.1.0" +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..d8115c5 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..6e97cb5 --- /dev/null +++ b/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" + ] +) \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..63e2e53 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx==4.5.0 +sphinx-rtd-theme==1.0.0 \ No newline at end of file diff --git a/docs/src/api.md b/docs/src/api.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/src/guide.md b/docs/src/guide.md new file mode 100644 index 0000000..e69de29