nexB/license-expression

Please provide a proper documentation

Closed this issue · 4 comments

stephanlachnit commented

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

@stephanlachnit Yes! you are right!

pombredanne commented

BTW I see you may be using it in https://github.com/stephanlachnit/dep5convert which looks very nice! ❤️
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

  • 👍1
pombredanne commented

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

stephanlachnit commented

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.

  • ❤️1