add documentation

Author: hamidrezaghafouri-hub

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,27 @@
+# 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 = 'DRAMAAtic'
+copyright = '2025, Hamidreza Ghafouri'
+author = 'Hamidreza Ghafouri'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+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 = 'sphinx_rtd_theme'
+html_static_path = ['_static']

docs/developer_guide.rst docs/source/developer_guide.rstdocs/developer_guide.rst renamed to docs/source/developer_guide.rst

@@ -0,0 +1,25 @@
+.. image:: https://drmaatic.biocomputingup.it/static/img/logo-dark.svg
+
+=============================
+ DRMAAtic Documentation
+=============================
+
+**DRMAAtic** (Dramatically improve your cluster potential) is an open-source RESTful API service for job scheduling on HPC clusters. It provides a web interface to submit and control jobs on a cluster’s Distributed Resource Manager (e.g., SLURM). The core idea is that each computational **job** is defined as a pre-configured **task** with specific execution parameters. Users select a task, provide input parameters, and submit the job, which is then forwarded to the cluster’s scheduler via the DRMAA library. DRMAAtic assigns a unique UUID to each job so users can track status and retrieve results.
+
+Key features of DRMAAtic include:
+
+- **REST API for Job Control:** Submit jobs, monitor status, and download results via HTTP requests.
+- **Cluster Integration:** Uses the **DRMAA** standard (with a SLURM implementation) for communicating with the cluster scheduler.
+- **Built on Django REST Framework:** Leverages Django and DRF for robust API endpoints.
+- **OAuth2 Authentication:** Integrates with external providers (e.g., ORCID) to issue JWT tokens for secure API access.
+- **Docker Deployment:** Provided container images and compose files for easy setup on clusters.
+
+.. note:: This documentation covers installation, usage and  development.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   installation
+   user_guide
+   developer_guide