conf.py

# -*- coding: utf-8 -*-
#
# OpenFAST documentation build configuration file, created by
# sphinx-quickstart on Wed Jan 25 13:52:07 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# 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
import subprocess
import re

#sys.path.append(os.path.abspath('_extensions/'))

readTheDocs = os.environ.get('READTHEDOCS', None) == 'True'
builddir = sys.argv[-1]
sourcedir = sys.argv[-2]

# Use this to turn Doxygen on or off
useDoxygen = False

# This function was adapted from https://gitlab.kitware.com/cmb/smtk
# Only run when on readthedocs
def runDoxygen(sourcfile, doxyfileIn, doxyfileOut):
    dx = open(os.path.join(sourcedir, doxyfileIn), 'r')
    cfg = dx.read()
    srcdir = os.path.abspath(os.path.join(os.getcwd(), '..'))
    bindir = srcdir
    c2 = re.sub('@CMAKE_SOURCE_DIR@', srcdir, re.sub('@CMAKE_BINARY_DIR@', bindir, cfg))
    doxname = os.path.join(sourcedir, doxyfileOut)
    dox = open(doxname, 'w')
    print(c2, file=dox)
    dox.close()
    print("Running Doxygen on {}".format(doxyfileOut))
    doxproc = subprocess.call(('doxygen', doxname))

if readTheDocs and useDoxygen:
    runDoxygen(sourcedir, 'Doxyfile.in', 'Doxyfile')

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.5.2'

# 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_rtd_theme',
    'sphinx.ext.autodoc',
    'sphinx.ext.autosummary',
    'sphinx.ext.mathjax',
    'sphinx.ext.intersphinx',
    'sphinxcontrib.doxylink',
    'sphinxcontrib.bibtex',
    'sphinxcontrib.mermaid',
]
bibtex_bibfiles = [
    'source/user/aerodyn-aeroacoustics/references.bib',
    'source/user/aerodyn-olaf/bibliography.bib',
    'source/user/aerodyn/bibliography.bib',
    'source/user/beamdyn/references.bib',
    'source/user/extptfm/bibliography.bib',
    'source/user/fast.farm/bibliography.bib',
    'source/user/hydrodyn/references.bib',
    'source/user/servodyn-stc/StC_Refs.bib',
    'source/user/subdyn/references_SD.bib'
]

autodoc_default_flags = [
    'members',
    'show-inheritance',
    'undoc-members'
]

autoclass_content = 'both'

mathjax_path = 'https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'

# FIXME: Naively assuming build directory one level up locally, and two up on readthedocs
if useDoxygen:
    if readTheDocs:
        doxylink = {
            'openfast': (
                os.path.join(builddir, '..', '..', 'openfast.tag'),
                os.path.join('html')
            )
        }
    else:
        doxylink = {
            'openfast': (
                os.path.join(builddir, '..', 'openfast.tag'),
                os.path.join('html')
            )
        }

# 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']

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'OpenFAST'
copyright = u'2023, National Renewable Energy Laboratory'
author = u'OpenFAST Team'

# 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 = u'3.5'
# The full version, including alpha/beta/rc tags.
release = u'v3.5.4'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
# language = None  # Default is English and None is not a valid option

#If true, figures, tables and code-blocks are automatically numbered if they 
#have a caption. At same time, the numref role is enabled. For now, it works 
#only with the HTML builder and LaTeX builder. Default is False.
numfig = True

# 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']

# FIXME: Naively assuming build directory one level up locally, and two up on readthedocs
if useDoxygen:
    if readTheDocs:
        html_extra_path = [os.path.join(builddir, '..', '..', 'doxygen')]
    else:
        html_extra_path = [os.path.join(builddir, '..', 'doxygen')]

# 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 = 'sphinx_rtd_theme'
html_logo = '_static/openfastlogo.jpg'

# 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 = {
    "analytics_id": "UA-68999653-10"
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']


# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'Openfastdoc'


# -- 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,
        'Openfast.tex',
        u'OpenFAST Documentation',
        u'National Renewable Energy Laboratory',
        'manual'
    ),
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (
        master_doc,
        'openfast',
        u'OpenFAST Documentation',
        [author],
        1
    )
]


# -- 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,
        'OpenFAST',
        u'OpenFAST Documentation',
        author,
        'OpenFAST',
        'One line description of project.',
        'Miscellaneous'
    ),
]

def setup(app):
    try:
        app.add_css_file('css/math_eq.css')
    except:
        pass
    app.add_object_type(
        "confval",
        "confval",
        objname="input file parameter",
        indextemplate="pair: %s; input file parameter"
    )
    app.add_object_type(
        "cmakeval",
        "cmakeval",
        objname="CMake configuration value",
        indextemplate="pair: %s; CMake configuration"
    )
# --- Prolog that will be included at the top of every rst file
# Here: defining the role :red: for html and latex
rst_prolog = r"""

.. raw:: html

    <style> .red {color:#ff0000} </style>

.. raw:: latex


    \makeatletter
     \@ifundefined{DUrolered}{%
       \newcommand{\DUrolered}[1]{{\color{red}{#1}}}
     }{}
    \makeatother

.. role:: red

"""