Merge pull request #1033 from wkliao/readthedocs

DOC: migrate documents to readthedocs

Author: wkliao

.readthedocs.yaml

@@ -2,13 +2,30 @@ version: "2"
 
 build:
   os: "ubuntu-22.04"
+  apt_packages:
+    - autoconf
+    - automake
+    - libtool
+    - libtool-bin
+    - m4
 
   tools:
     python: "3.10"
+  jobs:
+    pre_install:
+      # configure and install of darshan-util is required
+      # Note DARSHAN_INSTALL_PREFIX is a readthedocs environment variable which
+      # must be defined in the readthedocs dashboard
+      - cd darshan-util && autoreconf -i
+      - mkdir -p build && cd build && ../darshan-util/configure --prefix=$DARSHAN_INSTALL_PREFIX && make -j4 install
+      # create pydarshan doc files
+      - cd darshan-util/pydarshan && pip install -r requirements_dev.txt && make docs
 
 python:
   install:
     - requirements: readthedocs/requirements.txt
+    - method: pip
+      path: darshan-util/pydarshan
 
 sphinx:
   configuration: conf.py

conf.py

@@ -1,29 +1,131 @@
-# Configuration file for the Sphinx documentation builder.
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# Documentation build configuration file.
+# This file must be stored at the root directory with name "conf.py".
+#
 
-# -- Project information
+import darshan
 
+# -- General configuration ---------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.napoleon',
+]
+
+
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = True
+napoleon_include_special_with_doc = True
+napoleon_use_ivar = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = {'.rst': 'restructuredtext'}
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
 project = u'Darshan'
 copyright = u"2025, Argonne National Laboratory"
 author = u""
 
-release = '0.1'
-version = '0.1.0'
+# The version info for the project you're documenting, acts as replacement
+# for |version| and |release|, also used in various other places throughout
+# the built documents.
+#
+# The short X.Y version.
+version = darshan.__version__
+# The full version, including alpha/beta/rc tags.
+release = darshan.__version__
 
-# -- General configuration
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-extensions = [
-    'sphinx.ext.duration',
-    'sphinx.ext.doctest',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.intersphinx',
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output -------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+#html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a
+# theme further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# -- Options for HTMLHelp output ---------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'darshandoc'
+
+# -- Options for LaTeX output ------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'darshan.tex', u'Darshan Documentation', u'Argonne National Laboratory', 'manual'),
 ]
 
+# -- Options for Texinfo output ----------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'darshan', u'Darshan Documentation', author, 'darshan', 'Utilities for Darshan HPC I/O instrumentation.', 'Miscellaneous'),
+]
+
+
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3/', None),
-    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+  "python": ('https://docs.python.org/', None),
+  "matplotlib": ("https://matplotlib.org", None),
 }
-intersphinx_disabled_domains = ['std']
-
-templates_path = ['_templates']