'matrices',
'proc_allocators',
'recorders',
'solvers',
'surrogate_models',
'solvers.linear',
'solvers.nonlinear',
'solvers.linesearch',
'test_suite',
'test_suite.components',
'vectors',
]
if os.path.isfile("make_sourcedocs"):
from openmdao.docs._utils.generate_sourcedocs import generate_docs
generate_docs("..", "../..", packages)
# 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 = '_theme'
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['.']
language = None
# exclude_patterns is a list of patterns, relative to package directory, that match files and
# directories to ignore when looking for package files.
exclude_patterns = ['_build', '_srcdocs/dev']
absp = os.path.join('.', '_srcdocs')
sys.path.insert(0, os.path.abspath(absp))
#packages, in the order you want to document them
packages = [
'package',
]
if os.path.isfile("make_sourcedocs"):
from openmdao.docs._utils.generate_sourcedocs import generate_docs
generate_docs("..", "../..", packages, "your_project")
# 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 = '_theme'
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['.']
'recorders',
'solvers',
'surrogate_models',
'solvers.linear',
'solvers.nonlinear',
'solvers.linesearch',
'test_suite.components',
'test_suite.scripts',
'vectors',
'utils',
'visualization',
]
if os.path.isfile("make_sourcedocs"):
from openmdao.docs._utils.generate_sourcedocs import generate_docs
generate_docs("..", "../..", packages)
# 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 = '_theme'
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['.']
'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage',
'sphinx.ext.mathjax', 'sphinx.ext.viewcode', 'sphinx.ext.githubpages',
'numpydoc', 'embed_code', 'embed_compare', 'embed_options'
]
# directories for which to generate sourcedocs
packages = [
'aerodynamics',
'functionals',
'geometry',
'integration',
'structures',
'transfer',
]
generate_docs("..", "../..", packages, project_name='openaerostruct')
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '1.6.2'
numpydoc_show_class_members = False
# The master toctree document.
#master_doc = 'index'
# General information about the project.
project = u'OpenAeroStruct'
copyright = u'2018, John Jasa, Dr. John Hwang, Justin S. Gray'
author = u'John Jasa, Dr. John Hwang, Justin S. Gray'