Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
S
solid_framework
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
jlab
solid
solid_framework
Commits
52f6837d
Commit
52f6837d
authored
5 years ago
by
Whitney Armstrong
Browse files
Options
Downloads
Patches
Plain Diff
modified: conf.py
parent
716616c5
No related branches found
No related tags found
No related merge requests found
Pipeline
#2908
passed
5 years ago
Stage: phase1
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/conf.py
+6
-48
6 additions, 48 deletions
docs/conf.py
with
6 additions
and
48 deletions
docs/conf.py
+
6
−
48
View file @
52f6837d
import
sphinx_rtd_theme
# Configuration file for the Sphinx documentation builder.
# Configuration file for the Sphinx documentation builder.
#
#
# This file only contains a selection of the most common options. For a full
# This file only contains a selection of the most common options. For a full
...
@@ -18,12 +17,14 @@ import sphinx_rtd_theme
...
@@ -18,12 +17,14 @@ import sphinx_rtd_theme
# -- Project information -----------------------------------------------------
# -- Project information -----------------------------------------------------
project
=
'
NPdet
'
project
=
'
Solid Framework
'
copyright
=
'
2020, Whitney Armstrong
'
copyright
=
'
2020, Whitney Armstrong
'
author
=
'
Whitney Armstrong
'
author
=
'
Whitney Armstrong
'
master_doc
=
'
index
'
# The full version, including alpha/beta/rc tags
# The full version, including alpha/beta/rc tags
release
=
'
0.
9
'
release
=
'
0.
1
'
# -- General configuration ---------------------------------------------------
# -- General configuration ---------------------------------------------------
...
@@ -31,33 +32,7 @@ release = '0.9'
...
@@ -31,33 +32,7 @@ release = '0.9'
# Add any Sphinx extension module names here, as strings. They can be
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
# ones.
extensions
=
[
'
recommonmark
'
,
'
sphinx_rtd_theme
'
,
'
breathe
'
,
'
exhale
'
]
extensions
=
[
'
recommonmark
'
]
# Setup the breathe extension
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
"
}
# Tell sphinx what the primary language being documented is.
primary_domain
=
'
cpp
'
# Tell sphinx what the pygments highlight language should be.
highlight_language
=
'
cpp
'
# Add any paths that contain templates here, relative to this directory.
# Add any paths that contain templates here, relative to this directory.
templates_path
=
[
'
_templates
'
]
templates_path
=
[
'
_templates
'
]
...
@@ -73,24 +48,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
...
@@ -73,24 +48,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The theme to use for HTML and HTML Help pages. See the documentation for
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# a list of builtin themes.
#
#
html_theme
=
'
sphinx_rtd_theme
'
html_theme
=
'
alabaster
'
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,
# 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,
# relative to this directory. They are copied after the builtin static files,
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment