CycloneDX / CycloneDX/cyclonedx-python-lib

[DOCS] showcases, examples & general docs improvements

Offen
#396 5 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
documentation help wanted
Vorherrschende Sprache
Python
Sterne
116
Forks
67
Ø Merge
8 T. 2 Std.
Gemergte PRs (30 T.)
2

Beschreibung

:mega: THIS IS A CALL FOR DOCS
Feel free to add pull requests with examples here:
- https://github.com/CycloneDX/cyclonedx-python-lib/tree/main/examples
- https://github.com/CycloneDX/cyclonedx-python-lib/blob/main/docs/examples.rst

----

There are currently no (complex) examples how to use this lib.

Yes, there are API docs, and small snippets, but no examples.
Even the unit tests do now showcase example usage, as they are much declarative or not expressive enough.

GOAL:
- [x] have examples in a `examples` folder
- [x] link the examples in the README
- [x] link the examples in the (api)-docs
- [x] prevent `examples` dir from being shipped (sdist/bdist)
- [x] have examples run in CI

----

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.