Skip to content

Commit

Permalink
Merge pull request #54 from Pennycook/app-efficiency-example
Browse files Browse the repository at this point in the history 
Add a new application_efficiency example
  • Loading branch information
@Pennycook
Pennycook authored Jul 25, 2024
2 parents c4ba486 + ed3bb48 commit 4bcbd1f
Show file tree
Hide file tree
Showing 3 changed files with 358 additions and 182 deletions.
204 changes: 22 additions & 182 deletions docs/source/conf.py
View file
Original file line number Diff line number Diff line change
@@ -1,42 +1,24 @@
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))

# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------

project = 'P3 Analysis Library'
copyright = ' Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others'
author = 'Intel Corporation'

# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = ''

# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "P3 Analysis Library"
copyright = (
" Intel Corporation. Intel, the Intel logo, and other Intel marks are "
+ "trademarks of Intel Corporation or its subsidiaries. Other names and "
+ "brands may be claimed as the property of others."
)
author = "Intel Corporation"
version = ""
release = ""

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#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.autodoc',
'sphinx.ext.napoleon',
Expand All @@ -45,167 +27,25 @@
'sphinx.ext.intersphinx',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
templates_path = ["_templates"]
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None


# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#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 = 'furo'

# 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 static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}

html_theme = "furo"
html_static_path = ["_static"]
html_title = "P3 Analysis Library"


# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'p3-analysis-library-doc'


# -- Options for LaTeX output ------------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(
master_doc, 'p3-analysis-library.tex',
'P3 Analysis Library Documentation',
'Intel Corporation', 'manual',
),
]


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(
master_doc, 'p3-analysis-library', 'P3 Analysis Library Documentation',
[author], 1,
),
]


# -- Options for Texinfo output ----------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(
master_doc, 'p3-analysis-library', 'P3 Analysis Library Documentation',
author, 'p3-analysis-library',
'A library simplifying the collection and interpretation of P3 data.',
'Miscellaneous',
),
]


# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']


# -- Extension configuration -------------------------------------------------

from sphinx_gallery.scrapers import matplotlib_scraper


class tight_scraper:

def __repr__(self):
return self.__class__.__name__

def __call__(self, *args, **kwargs):
return matplotlib_scraper(*args, bbox_inches="tight", **kwargs)

sphinx_gallery_conf = {
'examples_dirs': ['../../examples','../../case-studies'],
'gallery_dirs': ['examples','case-studies'],
'image_scrapers': (tight_scraper(),),
'run_stale_examples': True,
'filename_pattern': '/',
'backreferences_dir' : 'gen_modules/backreferences',
}

intersphinx_mapping = {
"matplotlib": ('https://matplotlib.org/stable/', None),
"pandas": ('https://pandas.pydata.org/pandas-docs/stable/', None),
}
6 changes: 6 additions & 0 deletions examples/metrics/README.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Metrics
-------

Generating metrics from raw P3 data is a pre-requisite for generating specific
plots. Understanding how to manipulate and prepare raw P3 data enables the
exploration of more complex "what if" scenarios and more detailed analyses.
Loading

0 comments on commit 4bcbd1f

Please sign in to comment.