Merge pull request #3 from spacetelescope/broken-rtd

RTD

.readthedocs.yml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: mambaforge-4.10
+
+conda:
+  environment: docs/environment.yaml
+
+sphinx:
+  configuration: docs/conf.py
+

docs/Doxyfile

@@ -6,9 +6,9 @@
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = "Oh My Cal"
 PROJECT_NUMBER         =
-PROJECT_BRIEF          =
-PROJECT_LOGO           =
-OUTPUT_DIRECTORY       = docs/output
+PROJECT_BRIEF          = "A pipeline delivery generator"
+PROJECT_LOGO           = logo.png
+OUTPUT_DIRECTORY       =
 CREATE_SUBDIRS         = NO
 CREATE_SUBDIRS_LEVEL   = 8
 ALLOW_UNICODE_NAMES    = NO
@@ -124,7 +124,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = README.md src include
+INPUT                  = ../README.md ../src ../include
 INPUT_ENCODING         = UTF-8
 INPUT_FILE_ENCODING    =
 FILE_PATTERNS          = *.c \
@@ -190,7 +190,7 @@ INPUT_FILTER           =
 FILTER_PATTERNS        =
 FILTER_SOURCE_FILES    = NO
 FILTER_SOURCE_PATTERNS =
-USE_MDFILE_AS_MAINPAGE = README.md
+USE_MDFILE_AS_MAINPAGE = ../README.md
 FORTRAN_COMMENT_AFTER  = 72
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
@@ -218,7 +218,7 @@ HTML_FILE_EXTENSION    = .html
 HTML_HEADER            =
 HTML_FOOTER            =
 HTML_STYLESHEET        =
-HTML_EXTRA_STYLESHEET  =
+HTML_EXTRA_STYLESHEET  = custom.css
 HTML_EXTRA_FILES       =
 HTML_COLORSTYLE        = AUTO_LIGHT
 HTML_COLORSTYLE_HUE    = 220

docs/conf.py

@@ -0,0 +1,47 @@
+# 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
+import sys
+
+print("current directory: {}".format(os.path.abspath(os.curdir)), file=sys.stderr)
+
+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'
+
+root_doc = "nop"
+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']

docs/environment.yaml

@@ -0,0 +1,8 @@
+name: RTD
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  - python=3.11
+  - doxygen
+  - graphviz