mirror of
https://github.com/AdaCore/e3-core.git
synced 2026-02-12 12:29:08 -08:00
0133ca57ca
This provenance package is the implementation of the SLSA provenance specifications at https://slsa.dev/spec/v1.0/provenance For now, at least two enhancements are possible: - Some parameters are TypeURI or ResourceURI, but the specification says they are strings. Setting those attributes as `str` and having a check that they fit with TypeURI or ResourceURI classes could be better. Documentation fixes ------------------- Removed some warning about autoapi documentation, and some about possible classes mixes. Still the warning about PIPE import in TYPE_CHECKING could not be resolved. Review changes -------------- - Removed DigestSet and DigestAlgorithm enum. A digest set is considered a dictionary of str: str. The ResourceDescriptor's digest may be set, or new digest added by the add_digest() method. - The dir_hash() method has been moved to ResourceDescriptor ... maybe not the best place though. - Fixed a minor typo in the dsse package documentation - Added `as_dict()`, `as_json()`, `load_dict()` and `load_json()` for all the objects. - Added a provenance file example in the tests, and load it.
129 lines
3.8 KiB
Python
129 lines
3.8 KiB
Python
#
|
|
# e3-core documentation build configuration file, created by
|
|
# sphinx-quickstart on Fri May 19 23:56:17 2017.
|
|
#
|
|
# 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.
|
|
|
|
# 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('.'))
|
|
# type: ignore
|
|
|
|
import sphinx_rtd_theme
|
|
|
|
|
|
# -- 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 = ["autoapi.extension"]
|
|
|
|
autoapi_type = "python"
|
|
autoapi_dirs = ["../../src/e3"]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ["_templates"]
|
|
autoapi_template_dir = "source/autoapi_templates"
|
|
|
|
# Remove warnings for auto API template.
|
|
exclude_patterns = ["autoapi_templates/index.rst"]
|
|
|
|
# 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"
|
|
|
|
# General information about the project.
|
|
project = "e3-core"
|
|
project_copyright = "2017, AdaCore"
|
|
author = "AdaCore"
|
|
|
|
# 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 = "24.0"
|
|
# The full version, including alpha/beta/rc tags.
|
|
release = "24.0"
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = "sphinx"
|
|
|
|
# -- 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 = "sphinx_rtd_theme"
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
|
|
# 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_static_path = []
|
|
|
|
|
|
# -- Options for HTMLHelp output ------------------------------------------
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = "e3-coredoc"
|
|
|
|
|
|
# -- Options for LaTeX output ---------------------------------------------
|
|
|
|
latex_elements = {}
|
|
|
|
# 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, "e3-core.tex", "e3-core Documentation", "AdaCore", "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, "e3-core", "e3-core 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,
|
|
"e3-core",
|
|
"e3-core Documentation",
|
|
author,
|
|
"e3-core",
|
|
"One line description of project.",
|
|
"Miscellaneous",
|
|
)
|
|
]
|