enhancement: API docs - Githubissues

crs4 / rocrate-validator

A Python package to validate RO-Crates

Apache License 2.0

7 stars 7 forks source link

enhancement: API docs #44

Open kikkomep opened 1 week ago

kikkomep commented 1 week ago

This PR continues to address issue #40. It introduces and initializes the documentation, with a particular focus on the API classes designed for programmatic interaction with the validator. A preview is available here, while the official version will be accessible at https://rocrate-validator.readthedocs.io after the first release following the integration of this PR (the CI has already been extended and configured to support the automatic generation of the documentation).

simleo commented 10 hours ago

Links like [CLI-based validation](#cli-based-validation) work only in the rendering of the Markdown file, not when included in the Sphinx-generated docs.