search

tweag / rules_sh

Shell rules for Bazel
Apache License 2.0
42 stars 3 forks source link

Autogenerate API documentation using Stardoc #24

Closed aherrmann closed 2 years ago

aherrmann commented 2 years ago

Is your feature request related to a problem? Please describe. The API documentation shown in the project README is hard-coded and not automatically kept in sync with the available definitions and docstrings in the project.

Describe the solution you'd like The API documentation shown in the README should be automatically generated using Stardoc. A test-case run on CI should ensure that the checked in README and the available definitions and docstrings in the project are in sync.

Describe alternatives you've considered None

Additional context rules_nixpkgs supports Stardoc generated API documentation. The setup used there could be re-used in this project.

benradf commented 2 years ago

Some follow up work needed in #33.