CycloneDX / CycloneDX/cyclonedx-python-lib

[DOCS] showcases, examples & general docs improvements

Abierto
#396 5 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation help wanted
Lenguaje dominante
Python
Estrellas
116
Forks
67
Merge medio
8 d 2 h
PR fusionados (30 d)
2

Descripción

: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

----

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.