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

Support for multiple source paths #34

Open
padlar opened this issue Sep 14, 2022 · 0 comments
Open

Support for multiple source paths #34

padlar opened this issue Sep 14, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@padlar
Copy link

padlar commented Sep 14, 2022

When generating docs for the operator with mutliple CRDs in different paths, it would be nice to specify multiple source paths. For ex, in the following folder structure -

api
- crd1
- crd2
- common

common contains shared structs used by both crd1 and crd2 CRDs. To generate adocs for crd1, I would have to pass folders crd1 and common. Similarly crd2 and common folders if I want docs for crd2.

I looked at the code that parses the source paths (processor/processor.go) and found out that the controller-tools has a LoadRoots api that supports reading from multiple source paths. So it shouldnt be too complex to support multiple source paths.

As a workaround to this problem, we are using config.yaml to exclude types in each adoc.

@thbkrkr thbkrkr added the enhancement New feature or request label Apr 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants