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

Module documentation renders in a weird way #71

Closed
arnaudsjs opened this issue Jul 19, 2024 · 3 comments · Fixed by #80
Closed

Module documentation renders in a weird way #71

arnaudsjs opened this issue Jul 19, 2024 · 3 comments · Fixed by #80
Assignees

Comments

@arnaudsjs
Copy link
Contributor

arnaudsjs commented Jul 19, 2024

Example: https://docs.inmanta.com/inmanta-service-orchestrator-dev/8/reference/modules/aci.html#aci.resources.StandaloneProvider

  • The handler name is rendered as ````. This happens because the handler doesn't set a name, because there is only one handler for multiple resources.
  • The same handler class is displayed multiple times in the documentation.

Related Slack discussion: https://inmanta.slack.com/archives/CKRF0C8R3/p1721380143263339

@sanderr
Copy link
Contributor

sanderr commented Jul 30, 2024

discussed in planning meeting:

  1. for the ```` issue, double check whether the name is not set + check with solutions team if we should allow it to be absent (it's currently typed str, not `Optional[str]`).
  2. The same handler class is displayed multiple times because we reuse the same class for multiple resources (stacked @provider). This should be displayed correctly. Investigate what is easiest.
  3. The generated documentation may be meaningless in the first place, given that we will soon be able to use the README.md to drive the docs. Check with the solutions team how relevant this ticket is (if we wouldn't ever generate it for these modules, it's not that meaningful).

@sanderr
Copy link
Contributor

sanderr commented Jul 30, 2024

Assigning to @hlloreda to check on point 3.

@hlloreda
Copy link
Contributor

hlloreda commented Oct 8, 2024

Point 1 seems to have disappeared. But point 2 is still relevant when it comes to generic handlers, so we should take action on this (this part of the documentation is still used).

@hlloreda hlloreda removed their assignment Oct 8, 2024
@arnaudsjs arnaudsjs self-assigned this Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants