Skip to content

Commit b0e5b43

Browse files
authored
docs (#546)
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent 7e55dfe commit b0e5b43

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ See the [LICENSE][license_file] file for the full license.
7474
[link_gh-workflow-test]: https://github.com/CycloneDX/cyclonedx-python-lib/actions/workflows/python.yml?query=branch%3Amain
7575
[link_pypi]: https://pypi.org/project/cyclonedx-python-lib/
7676
[link_conda-forge]: https://anaconda.org/conda-forge/cyclonedx-python-lib
77-
[link_rtfd]: https://cyclonedx-python-library.readthedocs.io/en/latest/?badge=latest
77+
[link_rtfd]: https://cyclonedx-python-library.readthedocs.io/en/latest/
7878
[link_codacy]: https://app.codacy.com/gh/CycloneDX/cyclonedx-python-lib
7979
[link_ossf-best-practices]: https://www.bestpractices.dev/projects/7956
8080
[link_website]: https://cyclonedx.org/

docs/architecture.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,12 @@ Architecture
1717

1818
This library broadly is separated into three key functional areas:
1919

20-
1. **Parser**: Downstream tools may provide concrete implementation of the :py:mod:`cyclonedx.parser.BaseParser` which
21-
can easily help you build a Model from your project or ecosystem.
22-
For Python specific parser implementations see `cyclonedx-python`_
23-
2. **Model**: Internal models used to unify data from different parsers
20+
1. **Model**: Internal models used to unify data from different parsers
2421

2522
**Note:** As of version 4.0.0 of this library we support deserialization from JSON and XML as well as
2623
serialization to JSON and XML.
2724

28-
3. **Output**: Choose and configure an output which allows you to define output format as well as the CycloneDX schema
25+
2. **Output**: Choose and configure an output which allows you to define output format as well as the CycloneDX schema
2926
version
3027

3128
When wishing to generate a BOM, the process is as follows:

docs/changelog.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,8 @@
1212
#
1313
# SPDX-License-Identifier: Apache-2.0
1414
15-
.. mdinclude:: ../CHANGELOG.md
15+
=========
16+
Changelog
17+
=========
18+
19+
.. mdinclude:: ../CHANGELOG.md

0 commit comments

Comments
 (0)