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

DOC cross-linking from API reference to user guide #654

Open
romanlutz opened this issue Jan 21, 2025 · 0 comments
Open

DOC cross-linking from API reference to user guide #654

romanlutz opened this issue Jan 21, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@romanlutz
Copy link
Contributor

Describe the issue linked to the documentation

It would be cool if we cross-linked from API reference to user guide examples that use a class, e.g., if the PromptSendingOrchestrator API reference page pointed to user guide pages that use it.

Suggest a potential alternative/fix

This should probably not be a manual effort as that will just get outdated. Instead, let's look for a sphinx-plugin or similar that can handle this. I know it does exist for sphinx-gallery. That's why you see gallery examples at the bottom of this page. Jupyter-book builds on sphinx so there may be some way of doing this automatically.

@romanlutz romanlutz added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed and removed good first issue Good for newcomers labels Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant