Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate gazelle documentation and publish it to RTD #1706

Closed
aignas opened this issue Jan 19, 2024 · 1 comment
Closed

Generate gazelle documentation and publish it to RTD #1706

aignas opened this issue Jan 19, 2024 · 1 comment
Labels
Can Close? Will close in 30 days if there is no new activity gazelle Gazelle plugin related issues type: documentation

Comments

@aignas
Copy link
Collaborator

aignas commented Jan 19, 2024

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:

  1. Use rules_python RTD domain.
  2. Use a rules_python_gazelle_plugin RTD domain.
  3. Keep the same README.

If we choose 1., then we may need to add rules_python_gazelle_plugin as a dev_dependency in order to get the distribution 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 from rules_python_gazelle_plugin workspace and it would give us some dog-fooding opportunities for the sphinxdocs 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.

Copy link

This issue has been automatically marked as stale because it has not had any activity for 180 days. It will be closed if no further activity occurs in 30 days.
Collaborators can add an assignee to keep this open indefinitely. Thanks for your contributions to rules_python!

@github-actions github-actions bot added the Can Close? Will close in 30 days if there is no new activity label Jul 17, 2024
@aignas aignas closed this as completed Jul 23, 2024
@aignas aignas reopened this Jul 23, 2024
@aignas aignas closed this as not planned Won't fix, can't repro, duplicate, stale Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Can Close? Will close in 30 days if there is no new activity gazelle Gazelle plugin related issues type: documentation
Projects
None yet
Development

No branches or pull requests

1 participant