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

API reference not really documenting #132

Open
camilogarciabotero opened this issue Apr 9, 2024 · 2 comments
Open

API reference not really documenting #132

camilogarciabotero opened this issue Apr 9, 2024 · 2 comments

Comments

@camilogarciabotero
Copy link
Member

I was inspecting the latest deployed docs after #129 was merged and found that the API was empty. When built locally it shows all the API of the rexported packages. But it seems that in the deployed it doesn't. I believe this is on the DocumenterVitepress.jl side.

Proofs:

  1. Locally:

Screenshot 2024-04-09 at 4 11 31 PM

  1. Deployment:

Screenshot 2024-04-09 at 4 11 12 PM

@kdpsingh
Copy link
Member

kdpsingh commented Apr 9, 2024

On one hand, from a user perspective, it would be really nice to have all the documentation in one place. So if there's a setting that would make re-exports show up on the generated docs, that would be great.

On the other hand, if it's not feasible, it's not a show-stopper as long as we link to the underlying base package documentation.

@camilogarciabotero
Copy link
Member Author

Hi @lazarusA do you know if this is a bug or a not supported feature of DocumenterVitepress.jl or can we enable that on the deployment?

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

No branches or pull requests

2 participants