385 lines
12 KiB
Python
385 lines
12 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# pydmd documentation build configuration file, created by
|
|
# sphinx-quickstart on Mon Jun 22 16:09:40 2015.
|
|
#
|
|
# 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 os
|
|
import sphinx_rtd_theme
|
|
import pina
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = pina.__project__
|
|
copyright = pina.__copyright__
|
|
author = pina.__author__
|
|
version = pina.__version__
|
|
|
|
|
|
sys.path.insert(0, os.path.abspath('../sphinx_extensions')) # extension to remove paramref link from lightinig
|
|
|
|
# -- General configuration ------------------------------------------------
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
# needs_sphinx = '1.4'
|
|
# if needs_sphinx > sphinx.__display_version__:
|
|
# message = 'This project needs at least Sphinx
|
|
# v{0!s}'.format(needs_sphinx)
|
|
# raise VersionRequirementError(message)
|
|
|
|
# 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.autosummary',
|
|
'sphinx.ext.doctest',
|
|
'sphinx.ext.napoleon',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.coverage',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx.ext.mathjax',
|
|
'sphinx.ext.intersphinx',
|
|
'paramref_extension', # this extension is made to remove paramref links from lightining doc
|
|
'sphinx_copybutton',
|
|
'sphinx_design'
|
|
]
|
|
|
|
# The root document.
|
|
root_doc = 'index'
|
|
|
|
# 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.
|
|
exclude_patterns = ['_build', 'docstrings', 'nextgen', 'Thumbs.db', '.DS_Store']
|
|
|
|
# The reST default role (used for this markup: `text`) to use for all documents.
|
|
#default_role = 'literal'
|
|
|
|
# Generate the API documentation when building
|
|
autosummary_generate = True
|
|
numpydoc_show_class_members = False
|
|
|
|
intersphinx_mapping = {
|
|
'python': ('http://docs.python.org/3', None),
|
|
# 'numpy': ('http://docs.scipy.org/doc/numpy/', None),
|
|
# 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
|
|
'matplotlib': ('https://matplotlib.org/stable', None),
|
|
'torch': ('https://pytorch.org/docs/stable/', None),
|
|
'pytorch_lightning': ("https://lightning.ai/docs/pytorch/stable/", None),
|
|
}
|
|
|
|
nitpicky = True
|
|
nitpick_ignore = [
|
|
('py:meth', 'pytorch_lightning.core.module.LightningModule.log'),
|
|
('py:meth', 'pytorch_lightning.core.module.LightningModule.log_dict'),
|
|
('py:exc', 'MisconfigurationException'),
|
|
('py:func', 'torch.inference_mode'),
|
|
('py:func', 'torch.no_grad'),
|
|
('py:class', 'torch.utils.data.DistributedSampler'),
|
|
('py:class', 'pina.model.layers.convolution.BaseContinuousConv'),
|
|
('py:class', 'Module'),
|
|
('py:class', 'torch.nn.modules.loss._Loss'), # TO FIX
|
|
('py:class', 'torch.optim.LRScheduler'), # TO FIX
|
|
|
|
]
|
|
|
|
|
|
# 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 encoding of source files.
|
|
# source_encoding = 'utf-8-sig'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = pina.__project__
|
|
copyright = pina.__copyright__
|
|
author = pina.__author__
|
|
|
|
# autoclass
|
|
autoclass_content = 'both'
|
|
|
|
# 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.
|
|
version = pina.__version__
|
|
# The full version, including alpha/beta/rc tags.
|
|
release = version
|
|
|
|
# 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'
|
|
|
|
# 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
|
|
# directories to ignore when looking for source files.
|
|
exclude_patterns = []
|
|
|
|
# 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.
|
|
pygments_style = 'sphinx'
|
|
|
|
# A list of ignored prefixes for module index sortins as "systems = False
|
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
todo_include_todos = True
|
|
|
|
|
|
# -- Options for viewcode extension ---------------------------------------
|
|
|
|
# Follow alias objects that are imported from another module such as functions,
|
|
# classes and attributes. As side effects, this option ... ???
|
|
# If false, ... ???.
|
|
# The default is True.
|
|
viewcode_import = True
|
|
|
|
|
|
# -- 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 = 'pydata_sphinx_theme'
|
|
|
|
# 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.
|
|
html_theme_path = [sphinx_rtd_theme.get_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.
|
|
# html_short_title = None
|
|
|
|
# The name of an image file (relative to this directory) to place at the top
|
|
# of the sidebar.
|
|
html_logo = "index_files/PINA_logo.png"
|
|
html_theme_options = {
|
|
"icon_links": [
|
|
{
|
|
"name": "GitHub",
|
|
"url": "https://github.com/mathLab/PINA",
|
|
"icon": "fab fa-github",
|
|
"type": "fontawesome",
|
|
},
|
|
{
|
|
"name": "Twitter",
|
|
"url": "https://x.com/pina_mathlab?s=21",
|
|
"icon": "fab fa-twitter",
|
|
"type": "fontawesome",
|
|
},
|
|
{
|
|
"name": "Email",
|
|
"url": "mailto:pina.mathlab@gmail.com",
|
|
"icon": "fas fa-envelope",
|
|
"type": "fontawesome",
|
|
},
|
|
],
|
|
"show_prev_next": False,
|
|
"navbar_start": ["navbar-logo"],
|
|
"navbar_end": ["navbar-icon-links"],
|
|
"header_links_before_dropdown": 8,
|
|
}
|
|
|
|
# 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
|
|
# pixels large.
|
|
# html_favicon = None
|
|
|
|
# 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']
|
|
html_css_files = [
|
|
'/css/custom.css',
|
|
]
|
|
# Add any extra paths that contain custom files (such as robots.txt or
|
|
# .htaccess) here, relative to this directory. These files are copied
|
|
# directly to the root of the documentation.
|
|
# html_extra_path = ['_tutorial']
|
|
|
|
# If not ''i, a 'Last updated on:' timestamp is inserted at every page bottom,
|
|
# using the given strftime format.
|
|
html_last_updated_fmt = '%b %d, %Y'
|
|
|
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
|
# 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
|
|
|
|
# Language to be used for generating the HTML full-text search index.
|
|
# Sphinx supports the following languages:
|
|
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
|
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
|
|
# html_search_language = 'en'
|
|
|
|
# A dictionary with options for the search language support, empty by default.
|
|
# Now only 'ja' uses this config value
|
|
# html_search_options = {'type': 'default'}
|
|
|
|
# The name of a javascript file (relative to the configuration directory) that
|
|
# implements a search results scorer. If empty, the default will be used.
|
|
# html_search_scorer = 'scorer.js'
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'pinadoc'
|
|
|
|
# -- Options for LaTeX output ---------------------------------------------
|
|
|
|
latex_elements = {
|
|
# The paper size ('letterpaper' or 'a4paper').
|
|
'papersize': 'a4paper',
|
|
|
|
# The font size ('10pt', '11pt' or '12pt').
|
|
'pointsize': '20pt',
|
|
|
|
# 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, 'pina.tex', u'PINA Documentation',
|
|
u'PINA contributors', 'manual'),
|
|
]
|
|
|
|
# The name of an image file (relative to this directory) to place at the top of
|
|
# the title page.
|
|
# latex_logo = None
|
|
|
|
# For "manual" documents, if this is true, then toplevel headings are parts,
|
|
# not chapters.
|
|
# latex_use_parts = False
|
|
|
|
# If true, show page references after internal links.
|
|
# latex_show_pagerefs = False
|
|
|
|
# If true, show URL addresses after external links.
|
|
# latex_show_urls = False
|
|
|
|
# Documents to append as an appendix to all manuals.
|
|
# latex_appendices = []
|
|
|
|
# If false, no module index is generated.
|
|
# latex_domain_indices = True
|
|
|
|
|
|
# -- 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, 'pina', u'PINA Documentation',
|
|
[author], 1)
|
|
]
|
|
|
|
# If true, show URL addresses after external links.
|
|
# man_show_urls = False
|
|
|
|
|
|
# -- 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, 'pina', u'PINA Documentation',
|
|
author, 'pina', 'One line description of project.',
|
|
'Miscellaneous'),
|
|
]
|
|
|
|
# Documents to append as an appendix to all manuals.
|
|
# texinfo_appendices = []
|
|
|
|
# If false, no module index is generated.
|
|
# texinfo_domain_indices = True
|
|
|
|
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
|
# texinfo_show_urls = 'footnote'
|
|
|
|
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
|
# texinfo_no_detailmenu = False
|
|
autodoc_member_order = 'bysource'
|