diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..abd0de459 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,14 @@ +version: "2" + +build: + os: "ubuntu-22.04" + + tools: + python: "3.10" + +python: + install: + - requirements: readthedocs/requirements.txt + +sphinx: + configuration: conf.py diff --git a/conf.py b/conf.py new file mode 100644 index 000000000..e09d6c414 --- /dev/null +++ b/conf.py @@ -0,0 +1,29 @@ +# Configuration file for the Sphinx documentation builder. + +# -- Project information + +project = u'Darshan' +copyright = u"2025, Argonne National Laboratory" +author = u"" + +release = '0.1' +version = '0.1.0' + +# -- General configuration + +extensions = [ + 'sphinx.ext.duration', + 'sphinx.ext.doctest', + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.intersphinx', +] + +intersphinx_mapping = { + 'python': ('https://docs.python.org/3/', None), + 'sphinx': ('https://www.sphinx-doc.org/en/master/', None), +} +intersphinx_disabled_domains = ['std'] + +templates_path = ['_templates'] + diff --git a/index.rst b/index.rst new file mode 100644 index 000000000..a590fdbcd --- /dev/null +++ b/index.rst @@ -0,0 +1,7 @@ +Welcome to Darshan's documentation! +=================================== + +.. note:: + + This project is under active development. + diff --git a/readthedocs/requirements.txt b/readthedocs/requirements.txt new file mode 100644 index 000000000..c101ac3e3 --- /dev/null +++ b/readthedocs/requirements.txt @@ -0,0 +1,6 @@ +sphinx==8.1.3 +sphinx-rtd-theme==3.0.2 +cffi +numpy +pandas +matplotlib