Skip to content

Commit 261b0aa

Browse files
authored
Merge pull request #1034 from wkliao/init_readthedocs
DOC: add a bare bones readthedocs yaml file
2 parents c60e872 + b963f9e commit 261b0aa

File tree

4 files changed

+56
-0
lines changed

4 files changed

+56
-0
lines changed

.readthedocs.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: "2"
2+
3+
build:
4+
os: "ubuntu-22.04"
5+
6+
tools:
7+
python: "3.10"
8+
9+
python:
10+
install:
11+
- requirements: readthedocs/requirements.txt
12+
13+
sphinx:
14+
configuration: conf.py

conf.py

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
3+
# -- Project information
4+
5+
project = u'Darshan'
6+
copyright = u"2025, Argonne National Laboratory"
7+
author = u""
8+
9+
release = '0.1'
10+
version = '0.1.0'
11+
12+
# -- General configuration
13+
14+
extensions = [
15+
'sphinx.ext.duration',
16+
'sphinx.ext.doctest',
17+
'sphinx.ext.autodoc',
18+
'sphinx.ext.autosummary',
19+
'sphinx.ext.intersphinx',
20+
]
21+
22+
intersphinx_mapping = {
23+
'python': ('https://docs.python.org/3/', None),
24+
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
25+
}
26+
intersphinx_disabled_domains = ['std']
27+
28+
templates_path = ['_templates']
29+

index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Welcome to Darshan's documentation!
2+
===================================
3+
4+
.. note::
5+
6+
This project is under active development.
7+

readthedocs/requirements.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
sphinx==8.1.3
2+
sphinx-rtd-theme==3.0.2
3+
cffi
4+
numpy
5+
pandas
6+
matplotlib

0 commit comments

Comments
 (0)