Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
N
NPDet
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
EIC
NPDet
Merge requests
!80
modified: ../README.md
Code
Review changes
Check out branch
Download
Patches
Plain diff
Merged
modified: ../README.md
whit/NPDet:docs
into
master
Overview
0
Commits
1
Pipelines
1
Changes
3
Merged
Whitney Armstrong
requested to merge
whit/NPDet:docs
into
master
5 years ago
Overview
0
Commits
1
Pipelines
1
Changes
3
Expand
modified: conf.py modified: index.rst
0
0
Merge request reports
Compare
master
master (base)
and
latest version
latest version
a09b81e2
1 commit,
5 years ago
3 files
+
35
−
36
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
Files
3
Search (e.g. *.vue) (Ctrl+P)
docs/conf.py
+
34
−
34
Options
@@ -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