Generate gazelle documentation and publish it to RTD #1706
Labels
Can Close?
Will close in 30 days if there is no new activity
gazelle
Gazelle plugin related issues
type: documentation
Right now the docs are not present for the macros that we export and it would be great to have docs generated for all of the publicly available macros/rules for gazelle.
Possible alternatives:
rules_python
RTD domain.rules_python_gazelle_plugin
RTD domain.If we choose 1., then we may need to add
rules_python_gazelle_plugin
as adev_dependency
in order to get thedistribution
filegroup in order to be able to build the docs. This may be a little bit hairy due to circular dependencies?If we choose 2., then we would need to register a new domain and use
sphinxdocs
fromrules_python_gazelle_plugin
workspace and it would give us some dog-fooding opportunities for thesphinxdocs
rules.If we choose 3., then we potentially need to point people to the README and the source and it has to be our policy for some time.
The text was updated successfully, but these errors were encountered: