Skip to content

Commit

Permalink
docs (#546)
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
  • Loading branch information
jkowalleck authored Jan 31, 2024
1 parent 7e55dfe commit b0e5b43
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
7 changes: 2 additions & 5 deletions docs/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 5 additions & 1 deletion docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,8 @@
#
# SPDX-License-Identifier: Apache-2.0
.. mdinclude:: ../CHANGELOG.md
=========
Changelog
=========

.. mdinclude:: ../CHANGELOG.md

0 comments on commit b0e5b43

Please sign in to comment.