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

Add support for querying multiple autodoc indexes at the same time. #13

Open
samheutmaker opened this issue Mar 26, 2023 · 1 comment
Open
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@samheutmaker
Copy link
Contributor

Currently Autodoc can only query a package in which it has been directly installed. It would like to support querying dependencies and peer packages that have been distributed with an Autodoc index.

Dependency packages fairly easy. For example, in my autodoc.config.json, I could specify that I want Autodoc into node_modules for packages that have an .autodoc folder and include them when query. This allows for composability of documentation across the dependency graph of any given project.

It's slightly more tough for peer packages. You would need some way to define peers and then have Autodoc pull in their .autodoc indexes from somewhere external.

@samheutmaker samheutmaker added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Mar 26, 2023
@samheutmaker samheutmaker changed the title Add support for querying multiple packages at the same time. Add support for querying multiple autodoc indexes at the same time. Mar 26, 2023
@slavakurilyak
Copy link

Supporting multiple Autodoc indexes would be a useful feature! A potential solution for querying peer packages or multiple Autodoc indexes could be a cloud-based Autodoc database for a fee.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants