# 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: # http://www.sphinx-doc.org/en/master/config # -- 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.append( "/Users/ppegion/.local/bin" ) #sys.path.insert(0, os.path.abspath('.')) # -- Project information ----------------------------------------------------- project = 'UFS stochastic physics' copyright = '2020, The Regents of the University of Colorado' author = 'Philip Pegion' # The full version, including alpha/beta/rc tags release = 'public' # assign master document master_doc = 'index' # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. # create doxygen documentation #import subprocess #read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' #print('read_the_docs_build',read_the_docs_build) #if read_the_docs_build: # subprocess.call('cd ../../ ; doxygen', shell=True) #extensions = ['sphinx.ext.autodoc', 'breathe'] ##extensions = ['breathe'] #breathe_projects = { "stochastic_physics": "../../xml/" } #breathe_default_project = "stochastic_physics" # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # 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 = [] # -- 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' # 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']