From 9cfb3ccee39c43e9326b26647596ac3b15abc0f7 Mon Sep 17 00:00:00 2001 From: Joseph Hunkeler Date: Mon, 4 Mar 2024 13:26:20 -0500 Subject: RTD integration begins --- docs/conf.py | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/conf.py (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..e6b3cd6 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,43 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) +import os +import shutil +import subprocess + +print("current directory: {}".format(os.path.abspath(os.curdir))) +if os.path.exists("html"): + shutil.rmtree("html") + +# Update doxygen config +subprocess.run("doxygen -u", shell=True) + +# Run doxygen +subprocess.run("doxygen", shell=True) + +# -- Project information ----------------------------------------------------- + +project = 'Oh My Cal' +copyright = '2023-2024, Space Telescope Science Institute' +author = 'Joseph Hunkeler' + +html_extra_path = ["html"] + +# -- General configuration --------------------------------------------------- + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] -- cgit From 5911c460a3a4d11dc42ea57e31caa66491f52819 Mon Sep 17 00:00:00 2001 From: Joseph Hunkeler Date: Mon, 4 Mar 2024 13:37:58 -0500 Subject: RTD config --- docs/conf.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index e6b3cd6..6610bbd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,23 +16,27 @@ import os import shutil import subprocess +import sys + +print("current directory: {}".format(os.path.abspath(os.curdir)), file=sys.stderr) -print("current directory: {}".format(os.path.abspath(os.curdir))) if os.path.exists("html"): shutil.rmtree("html") # Update doxygen config -subprocess.run("doxygen -u", shell=True) +#subprocess.run("doxygen -u", shell=True) # Run doxygen subprocess.run("doxygen", shell=True) + # -- Project information ----------------------------------------------------- project = 'Oh My Cal' copyright = '2023-2024, Space Telescope Science Institute' author = 'Joseph Hunkeler' +root_doc = "nop" html_extra_path = ["html"] # -- General configuration --------------------------------------------------- -- cgit