search

aboutcode-org / license-expression

Utility library to parse, normalize and compare License expressions for Python using a boolean logic engine. For expressions using SPDX or any other license id scheme.
http://aboutcode.org
Other
58 stars 24 forks source link

Please provide a proper documentation #73

Closed stephanlachnit closed 2 years ago

stephanlachnit commented 2 years ago

Currently the docs folder only contains a placeholder documentation. It would be nice if license-expression would at least have an automatically created API documentation via sphinx.ext.autodoc.

pombredanne commented 2 years ago

@stephanlachnit Yes! you are right!

pombredanne commented 2 years ago

BTW I see you may be using it in https://github.com/stephanlachnit/dep5convert which looks very nice! :heart: You may fancy checking out this https://github.com/nexB/debian-inspector to deal with the basics of deb822 and copyright files and this for extensive Debian copyright support https://github.com/nexB/scancode-toolkit/blob/develop/src/packagedcode/debian_copyright.py .... and this also includes some license-expression usage examples

pombredanne commented 2 years ago

@stephanlachnit could I interest you in a PR for the doc? :angel: :innocent: @AyanSinhaMahapatra do you know if this repo is this enabled for autodoc publishing in RTD otherwise?

stephanlachnit commented 2 years ago

You may fancy checking out this https://github.com/nexB/debian-inspector to deal with the basics of deb822 and copyright files and this for extensive Debian copyright support https://github.com/nexB/scancode-toolkit/blob/develop/src/packagedcode/debian_copyright.py .... and this also includes some license-expression usage examples

Cool, I will check it out!

could I interest you in a PR for the doc?

See #74.