This commit fixes the following errors:
/docs/source/autoapi/anod/qualifier/index.rst:25: ERROR: Unexpected indentation.
/docs/source/autoapi/anod/qualifier/index.rst:26: WARNING: Block quote ends without a blank line; unexpected unindent.
/docs/source/autoapi/anod/qualifier/index.rst:29: ERROR: Unexpected indentation.
/docs/source/autoapi/anod/qualifier/index.rst:32: WARNING: Inline strong start-string without end-string.
This error is caused by the Python default documentation of a dictionary.
On Sphinx when no class documentation is provided, the default class
documentation becomes the documentation of the inherited type. Visibly, the
default documentation of the Python `dict` is not correct from the Sphinx
point of view.
This commit also improves some minor parts of the documentation of this
module.
The issue comes from the astroid version used. Currently, `astroid>=4`
cannot be used to build the documentation.
This commit fix the documentation build on readthedocs by adding
`astroid>=3,<4` to the `docs/requirements.txt`.
The fix for `tox -e docs` will be done in the cookiecutter repository as
the `tox.ini` file is managed by cookiecutter. See: it/cookiecutter-e3!92it/e3-core#61
Remove deprecated requirements traceability which is not maintained.
Create e3.pytest to reuse part of the code in conftest.py in other
projects.
Document the new plugin.
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.
Last time, the doc build failed because rtd was not fully supported by
Sphinx7. (See: https://github.com/readthedocs/sphinx_rtd_theme/issues/1463)
This problem has now been corrected, so we want to use the latest
rtd-compatible version of Sphinx.
Also fix the requirements version used in order to avoid future build
failure.
We do not support the latest versions of sphinx (at least sphinx v7.2.5).
Currently, we have forced readthedoc to use the latest version of sphinx
known to work with e3-core: v5.3.0.
