Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
29 changes: 29 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
@@ -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']

7 changes: 7 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Welcome to Darshan's documentation!
===================================

.. note::

This project is under active development.

6 changes: 6 additions & 0 deletions readthedocs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
sphinx==8.1.3
sphinx-rtd-theme==3.0.2
cffi
numpy
pandas
matplotlib