From b0e5b43880e17ec6ce23d5d4e1e7a9a2547c1e79 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 31 Jan 2024 21:25:27 +0100 Subject: [PATCH] docs (#546) Signed-off-by: Jan Kowalleck --- README.md | 2 +- docs/architecture.rst | 7 ++----- docs/changelog.rst | 6 +++++- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 88e753f1..cebf675c 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ See the [LICENSE][license_file] file for the full license. [link_gh-workflow-test]: https://github.com/CycloneDX/cyclonedx-python-lib/actions/workflows/python.yml?query=branch%3Amain [link_pypi]: https://pypi.org/project/cyclonedx-python-lib/ [link_conda-forge]: https://anaconda.org/conda-forge/cyclonedx-python-lib -[link_rtfd]: https://cyclonedx-python-library.readthedocs.io/en/latest/?badge=latest +[link_rtfd]: https://cyclonedx-python-library.readthedocs.io/en/latest/ [link_codacy]: https://app.codacy.com/gh/CycloneDX/cyclonedx-python-lib [link_ossf-best-practices]: https://www.bestpractices.dev/projects/7956 [link_website]: https://cyclonedx.org/ diff --git a/docs/architecture.rst b/docs/architecture.rst index 4a8fa7c2..a3ec410c 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -17,15 +17,12 @@ Architecture This library broadly is separated into three key functional areas: -1. **Parser**: Downstream tools may provide concrete implementation of the :py:mod:`cyclonedx.parser.BaseParser` which - can easily help you build a Model from your project or ecosystem. - For Python specific parser implementations see `cyclonedx-python`_ -2. **Model**: Internal models used to unify data from different parsers +1. **Model**: Internal models used to unify data from different parsers **Note:** As of version 4.0.0 of this library we support deserialization from JSON and XML as well as serialization to JSON and XML. -3. **Output**: Choose and configure an output which allows you to define output format as well as the CycloneDX schema +2. **Output**: Choose and configure an output which allows you to define output format as well as the CycloneDX schema version When wishing to generate a BOM, the process is as follows: diff --git a/docs/changelog.rst b/docs/changelog.rst index 5941b19b..bf6126a8 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -12,4 +12,8 @@ # # SPDX-License-Identifier: Apache-2.0 -.. mdinclude:: ../CHANGELOG.md \ No newline at end of file +========= +Changelog +========= + +.. mdinclude:: ../CHANGELOG.md