Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
tsoc
openmm
Commits
0d8b5165
Commit
0d8b5165
authored
Nov 02, 2015
by
Robert McGibbon
Browse files
remove excessive comments
parent
55a8d83a
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
14 additions
and
131 deletions
+14
-131
docs-source/python-api/conf.py
docs-source/python-api/conf.py
+14
-131
No files found.
docs-source/python-api/conf.py
View file @
0d8b5165
# -*- coding: utf-8 -*-
# -*- coding: utf-8 -*-
#
# MDTraj documentation build configuration file, created by
# sphinx-quickstart on Tue Jun 11 21:23:28 2013.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import
sys
import
sys
import
os
import
os
import
simtk.openmm.version
import
simtk.openmm.version
# 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.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions
=
[
'sphinx.ext.mathjax'
,
'sphinx.ext.ifconfig'
,
'sphinx.ext.autosummary'
,
extensions
=
[
'sphinx.ext.mathjax'
,
'sphinx.ext.ifconfig'
,
'sphinx.ext.autosummary'
,
'sphinx.ext.autodoc'
,
'numpydoc'
,
'sphinx.ext.intersphinx'
,]
'sphinx.ext.autodoc'
,
'numpydoc'
,
'sphinx.ext.intersphinx'
,]
autosummary_generate
=
True
autosummary_generate
=
True
autodoc_default_flags
=
[
'members'
,
'inherited-members'
]
autodoc_default_flags
=
[
'members'
,
'inherited-members'
]
html_theme_options
=
{
'logo'
:
'OPENMMLogo.png'
,
'description'
:
'A high performance GPU molecular simulation toolkit'
,
'github_user'
:
'pandegroup'
,
'github_repo'
:
'openmm'
,
'travis_button'
:
True
,
}
html_sidebars
=
{
'**'
:
[
'about.html'
,
'navigation.html'
,
'searchbox.html'
,
]
}
_python_doc_base
=
'http://docs.python.org/2.7'
_python_doc_base
=
'http://docs.python.org/2.7'
intersphinx_mapping
=
{
intersphinx_mapping
=
{
_python_doc_base
:
None
,
_python_doc_base
:
None
,
...
@@ -62,9 +21,6 @@ templates_path = ['_templates']
...
@@ -62,9 +21,6 @@ templates_path = ['_templates']
# The suffix of source filenames.
# The suffix of source filenames.
source_suffix
=
'.rst'
source_suffix
=
'.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
# The master toctree document.
master_doc
=
'index'
master_doc
=
'index'
...
@@ -72,76 +28,38 @@ master_doc = 'index'
...
@@ -72,76 +28,38 @@ master_doc = 'index'
project
=
u
'OpenMM'
project
=
u
'OpenMM'
copyright
=
u
'2015, Stanford University and the Authors'
copyright
=
u
'2015, Stanford University and the Authors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
# The short X.Y version.
version
=
simtk
.
openmm
.
version
.
short_version
version
=
simtk
.
openmm
.
version
.
short_version
# The full version, including alpha/beta/rc tags.
# The full version, including alpha/beta/rc tags.
release
=
simtk
.
openmm
.
version
.
full_version
release
=
simtk
.
openmm
.
version
.
full_version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# directories to ignore when looking for source files.
exclude_patterns
=
[
'_build'
]
exclude_patterns
=
[
'_build'
]
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names
=
False
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
# The name of the Pygments (syntax highlighting) style to use.
pygments_style
=
'sphinx'
pygments_style
=
'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# 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
=
"alabaster"
html_theme
=
"alabaster"
html_theme_options
=
{
'logo'
:
'OPENMMLogo.png'
,
'description'
:
'A high performance GPU molecular simulation toolkit'
,
'github_user'
:
'pandegroup'
,
'github_repo'
:
'openmm'
,
'travis_button'
:
True
,
}
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path
=
[]
html_theme_path
=
[]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo
=
''
# The name of an image file (within the static path) to use as favicon of the
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# pixels large.
...
@@ -152,49 +70,14 @@ html_logo = ''
...
@@ -152,49 +70,14 @@ html_logo = ''
# so a file named "default.css" will overwrite the builtin "default.css".
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path
=
[
'_static'
]
html_static_path
=
[
'_static'
]
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
html_sidebars
=
{
# using the given strftime format.
'**'
:
[
#html_last_updated_fmt = '%b %d, %Y'
'about.html'
,
'navigation.html'
,
# If true, SmartyPants will be used to convert quotes and dashes to
'searchbox.html'
,
# typographically correct entities.
]
#html_use_smartypants = True
}
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
# htmlhelp_basename = ''
autodoc_member_order
=
'bysource'
autodoc_member_order
=
'bysource'
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment