Skip to content
Snippets Groups Projects

modified: ../README.md

Merged Whitney Armstrong requested to merge whit/NPDet:docs into master
3 files
+ 35
36
Compare changes
  • Side-by-side
  • Inline
Files
3
+ 34
34
@@ -31,27 +31,27 @@ release = '0.9'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [ 'recommonmark','sphinx_rtd_theme', 'breathe', 'exhale' ]
extensions = [ 'recommonmark','sphinx_rtd_theme']
# Setup the breathe extension
breathe_projects = {
"My Project": "./doxyoutput/xml"
}
breathe_default_project = "My Project"
#breathe_projects = {
# "My Project": "./doxyoutput/xml"
#}
#breathe_default_project = "My Project"
# Setup the exhale extension
exhale_args = {
# These arguments are required
"containmentFolder": "./api",
"rootFileName": "library_root.rst",
"rootFileTitle": "Library API",
"doxygenStripFromPath": "..",
# Suggested optional arguments
"createTreeView": True,
# TIP: if using the sphinx-bootstrap-theme, you need
# "treeViewIsBootstrap": True,
"exhaleExecutesDoxygen": True,
"exhaleDoxygenStdin": "INPUT = ../src/GenericDetectors/beamline/src"
}
#exhale_args = {
# # These arguments are required
# "containmentFolder": "./api",
# "rootFileName": "library_root.rst",
# "rootFileTitle": "Library API",
# "doxygenStripFromPath": "..",
# # Suggested optional arguments
# "createTreeView": True,
# # TIP: if using the sphinx-bootstrap-theme, you need
# # "treeViewIsBootstrap": True,
# "exhaleExecutesDoxygen": True,
# "exhaleDoxygenStdin": "INPUT = ../src/GenericDetectors/beamline/src"
#}
# Tell sphinx what the primary language being documented is.
primary_domain = 'cpp'
@@ -74,22 +74,22 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme_options = {
'canonical_url': '',
'analytics_id': 'UA-XXXXXXX-1', # Provided by Google in your dashboard
'logo_only': False,
'display_version': True,
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
#'vcs_pageview_mode': '',
'style_nav_header_background': 'white',
# Toc options
'collapse_navigation': True,
'sticky_navigation': True,
'navigation_depth': 4,
'includehidden': True,
'titles_only': False
}
#html_theme_options = {
# 'canonical_url': '',
# 'analytics_id': 'UA-XXXXXXX-1', # Provided by Google in your dashboard
# 'logo_only': False,
# 'display_version': True,
# 'prev_next_buttons_location': 'bottom',
# 'style_external_links': False,
# #'vcs_pageview_mode': '',
# 'style_nav_header_background': 'white',
# # Toc options
# 'collapse_navigation': True,
# 'sticky_navigation': True,
# 'navigation_depth': 4,
# 'includehidden': True,
# 'titles_only': False
#}
# Add any paths that contain custom static files (such as style sheets) here,
Loading