update doc
This commit is contained in:
Dario Coscia
committed by
Nicola Demo
Nicola Demo
parent
e917753702
commit
2526da36bf
@@ -19,84 +19,84 @@ import importlib.metadata
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
_DISTRIBUTION_METADATA = importlib.metadata.metadata('pina-mathlab')
|
||||
project = _DISTRIBUTION_METADATA['Name']
|
||||
copyright = _DISTRIBUTION_METADATA['License-File']
|
||||
author = "PINA contributors"
|
||||
version = _DISTRIBUTION_METADATA['Version']
|
||||
_DISTRIBUTION_METADATA = importlib.metadata.metadata("pina-mathlab")
|
||||
project = _DISTRIBUTION_METADATA["Name"]
|
||||
copyright = _DISTRIBUTION_METADATA["License-File"]
|
||||
author = "PINA Contributors"
|
||||
version = _DISTRIBUTION_METADATA["Version"]
|
||||
|
||||
|
||||
sys.path.insert(0, os.path.abspath('../sphinx_extensions')) # extension to remove paramref link from lightinig
|
||||
sys.path.insert(
|
||||
0, os.path.abspath("../sphinx_extensions")
|
||||
)
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
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'
|
||||
"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']
|
||||
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'
|
||||
# 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),
|
||||
'matplotlib': ('https://matplotlib.org/stable', None),
|
||||
'torch': ('https://pytorch.org/docs/stable/', None),
|
||||
'lightning.pytorch': ("https://lightning.ai/docs/pytorch/stable/", None),
|
||||
}
|
||||
"python": ("http://docs.python.org/3", None),
|
||||
"matplotlib": ("https://matplotlib.org/stable", None),
|
||||
"torch": ("https://pytorch.org/docs/stable/", None),
|
||||
"lightning.pytorch": ("https://lightning.ai/docs/pytorch/stable/", None),
|
||||
"torch_geometric": (
|
||||
"https://pytorch-geometric.readthedocs.io/en/latest/",
|
||||
None,
|
||||
),
|
||||
}
|
||||
|
||||
nitpicky = True
|
||||
nitpick_ignore = [
|
||||
# ('py:meth', 'lightning.pytorch.core.module.LightningModule.log'),
|
||||
# ('py:meth', 'lightning.pytorch.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
|
||||
|
||||
]
|
||||
# nitpicky = True
|
||||
# nitpick_ignore = [
|
||||
# ("py:meth", "lightning.pytorch.core.module.LightningModule.log"),
|
||||
# ("py:meth", "lightning.pytorch.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']
|
||||
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'
|
||||
source_suffix = ".rst"
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
master_doc = "index"
|
||||
|
||||
# autoclass
|
||||
autoclass_content = 'both'
|
||||
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
|
||||
@@ -108,7 +108,7 @@ release = version
|
||||
#
|
||||
# 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'
|
||||
language = "en"
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
@@ -122,7 +122,7 @@ add_function_parentheses = True
|
||||
add_module_names = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
pygments_style = "sphinx"
|
||||
|
||||
# A list of ignored prefixes for module index sortins as "systems = False
|
||||
|
||||
@@ -143,7 +143,7 @@ viewcode_import = True
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'pydata_sphinx_theme'
|
||||
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
|
||||
@@ -151,7 +151,7 @@ html_theme = 'pydata_sphinx_theme'
|
||||
# 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()]
|
||||
# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
@@ -162,7 +162,7 @@ html_theme_options = {
|
||||
"name": "GitHub",
|
||||
"url": "https://github.com/mathLab/PINA",
|
||||
"icon": "fab fa-github",
|
||||
"type": "fontawesome",
|
||||
"type": "fontawesome",
|
||||
},
|
||||
{
|
||||
"name": "Twitter",
|
||||
@@ -172,7 +172,7 @@ html_theme_options = {
|
||||
},
|
||||
{
|
||||
"name": "Email",
|
||||
"url": "mailto:pina.mathlab@gmail.com",
|
||||
"url": "mailto:pina.mathlab@gmail.com",
|
||||
"icon": "fas fa-envelope",
|
||||
"type": "fontawesome",
|
||||
},
|
||||
@@ -185,7 +185,7 @@ html_theme_options = {
|
||||
|
||||
# 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'
|
||||
html_last_updated_fmt = "%b %d, %Y"
|
||||
|
||||
# If false, no index is generated.
|
||||
html_use_index = True
|
||||
@@ -197,40 +197,52 @@ html_show_sourcelink = True
|
||||
html_show_copyright = True
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'pinadoc'
|
||||
htmlhelp_basename = "pinadoc"
|
||||
|
||||
# Link to external html files
|
||||
html_extra_path = ["tutorials"]
|
||||
|
||||
# Avoid side bar for html files
|
||||
html_sidebars = {
|
||||
"_tutorial": [],
|
||||
"_team": [],
|
||||
"_cite": [],
|
||||
"_contributing": [],
|
||||
"_installation": [],
|
||||
"_LICENSE": [],
|
||||
}
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
'papersize': 'a4paper',
|
||||
|
||||
"papersize": "a4paper",
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
'pointsize': '20pt',
|
||||
|
||||
"pointsize": "20pt",
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
'preamble': '',
|
||||
|
||||
"preamble": "",
|
||||
# Latex figure (float) alignment
|
||||
'figure_align': 'htbp',
|
||||
"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'),
|
||||
(
|
||||
master_doc,
|
||||
"pina.tex",
|
||||
"PINA Documentation",
|
||||
"PINA contributors",
|
||||
"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, 'pina', u'PINA Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
man_pages = [(master_doc, "pina", "PINA Documentation", [author], 1)]
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
@@ -238,11 +250,20 @@ man_pages = [
|
||||
# (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'),
|
||||
(
|
||||
master_doc,
|
||||
"pina",
|
||||
"PINA Documentation",
|
||||
author,
|
||||
"pina",
|
||||
"One line description of project.",
|
||||
"Miscellaneous",
|
||||
),
|
||||
]
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
# texinfo_no_detailmenu = False
|
||||
autodoc_member_order = 'bysource'
|
||||
autodoc_member_order = "bysource"
|
||||
|
||||
# Do consider meth ending with _ (needed for in-place methods of torch)
|
||||
strip_signature_backslash = True
|
||||
|
||||
Reference in New Issue
Block a user