aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2024-03-04 13:26:20 -0500
committerJoseph Hunkeler <jhunkeler@gmail.com>2024-03-04 19:11:28 -0500
commit9cfb3ccee39c43e9326b26647596ac3b15abc0f7 (patch)
treeeb40b4f0319080c7317c5cb5b255cc7488cead62 /docs
parent07cf6064bb16fa45081ac1bb0d775507af853687 (diff)
downloadstasis-9cfb3ccee39c43e9326b26647596ac3b15abc0f7.tar.gz
RTD integration begins
Diffstat (limited to 'docs')
-rw-r--r--docs/Doxyfile12
-rw-r--r--docs/conf.py43
-rw-r--r--docs/environment.yml8
-rw-r--r--docs/index.rst0
-rw-r--r--docs/logo.pngbin0 -> 10788 bytes
5 files changed, 57 insertions, 6 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile
index d6509e6..05193d9 100644
--- a/docs/Doxyfile
+++ b/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
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']
diff --git a/docs/environment.yml b/docs/environment.yml
new file mode 100644
index 0000000..fed35ba
--- /dev/null
+++ b/docs/environment.yml
@@ -0,0 +1,8 @@
+name: RTD
+channels:
+ - conda-forge
+ - defaults
+dependencies:
+ - python=3.11
+ - doxygen
+ - graphviz
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/index.rst
diff --git a/docs/logo.png b/docs/logo.png
new file mode 100644
index 0000000..c7f7ad5
--- /dev/null
+++ b/docs/logo.png
Binary files differ