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

Is there a way to generate docs for all packages in a project #90

Open
githoober opened this issue Apr 20, 2023 · 1 comment
Open

Is there a way to generate docs for all packages in a project #90

githoober opened this issue Apr 20, 2023 · 1 comment
Labels
question Further information is requested

Comments

@githoober
Copy link

Assuming a tree-like package organization exists in a project, is there a way to generate documentation for all of them with a root index file?

@princjef
Copy link
Owner

Hi @githoober, you can generate a single document or a tree of documents for the packages in a repository with the tool today via ./... and the -output flag (omit {{.Dir}} to collapse docs into one file).

There is no way to generate a root file that points at all generated documentation files, but it should be feasible to add. If you're interested in sending a PR for the change I'll consider adding it in. A hand-written root index file may also be reasonable depending on your use case.

@princjef princjef added the question Further information is requested label Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants