docs: Restructure API reference navigation#199
Open
sanjeed5 wants to merge 12 commits intogenerate-v1.xfrom
Open
docs: Restructure API reference navigation#199sanjeed5 wants to merge 12 commits intogenerate-v1.xfrom
sanjeed5 wants to merge 12 commits intogenerate-v1.xfrom
Conversation
- Replace confusing nested "Core API" structure with clear product-aligned sections - Add Overview page with decision table for choosing SDK components - Split Platform Client APIs into individual pages (Datasets, Datapoints, etc.) - Create dedicated Tracing section (HoneyHiveTracer, Decorators, Enrichment) - Create dedicated Experiments and Configuration sections - Remove duplicate orphaned files from reference root - Simplify reference pages to pure autodoc (examples belong in tutorials) Co-authored-by: Cursor <cursoragent@cursor.com>
…-apis references Co-authored-by: Cursor <cursoragent@cursor.com>
…lts.rst Co-authored-by: Cursor <cursoragent@cursor.com>
…ference warning Co-authored-by: Cursor <cursoragent@cursor.com>
docutils 0.22 removed 'backrefs' attribute from nodes, which breaks
sphinx_tabs that does attrs.pop('backrefs'). Pin to <0.22 until
sphinx_tabs is updated to handle the change.
Co-authored-by: Cursor <cursoragent@cursor.com>
sanjeed5
force-pushed
the
docs/api-reference-navigation
branch
from
b673ff9 to
2a23bb0
Compare
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Replace tab directives with sequential bold sections showing different configuration approaches. Tabs were a cosmetic feature that added a brittle dependency. Files changed: - docs/reference/api/tracer.rst - docs/reference/configuration/config-options.rst - docs/tutorials/advanced-configuration.rst Co-authored-by: Cursor <cursoragent@cursor.com>
- Remove sphinx_tabs.tabs from conf.py extensions - Remove sphinx-tabs from requirements.txt - Remove non-existent sphinx-search package - Remove docutils<0.22 pin (no longer needed) sphinx-tabs was unmaintained and broken with docutils 0.22. sphinx-search package never existed on PyPI. Co-authored-by: Cursor <cursoragent@cursor.com>
Replace hardcoded pip install commands with single pip install -r docs/requirements.txt for consistency between local and CI builds. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
📚 Documentation Preview Built✅ Documentation preview is ready! 📦 Download PreviewDownload documentation artifact 🔍 How to Review
✅ Validation Status
Preview generated for PR #199 |
Revert commit 03eda3d which added: - Type annotation removal from trace_class (code change) - Example files (not docs-related) These belong in a separate PR, not in a docs restructure PR. Co-authored-by: Cursor <cursoragent@cursor.com>
|
You have run out of free Bugbot PR reviews for this billing cycle. This will reset on February 5. To receive reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial. |
Fixed Sphinx ambiguous cross-reference warning for 'type' parameter in trace_class decorator docstring by explicitly specifying the type hint in the Args section. This prevents Sphinx from trying to cross-reference to model .type attributes. Co-authored-by: Cursor <cursoragent@cursor.com>
sanjeed5
force-pushed
the
docs/api-reference-navigation
branch
from
20dfa27 to
b0a913e
Compare
Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
📚 Documentation Preview Built✅ Documentation preview is ready! 📦 Download PreviewDownload documentation artifact 🔍 How to Review
✅ Validation Status
Preview generated for PR #199 |
Remove the broad Sphinx warning suppression for Python cross-references so broken API references surface during docs builds. Co-authored-by: Cursor <cursoragent@cursor.com>
dhruv-hhai
approved these changes
Feb 6, 2026
dhruv-hhai
approved these changes
Feb 9, 2026
| Overview | ||
| ======== | ||
|
|
||
| This reference documents the HoneyHive Python SDK's public API. |
Contributor
There was a problem hiding this comment.
Add a ref to the python SDK version here if possible + link to the github releases for accessing changelog.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated PR description
Summary
reference/overviewwith a simple decision table to help users find the right SDK surface area quicklyreference/client/(datasets, datapoints, projects, sessions, events, metrics, configurations, tools, experiments)reference/tracing/section (tracer, decorators, enrichment) and linked to existing tracer architecture + config model reference pagesreference/api/client-apispageDocs tooling / CI follow-ups included
sphinx-tabs(unmaintained / docutils 0.22 breakage) and converted tabs to plain sectionssphinx-searchfromdocs/requirements.txt(package doesn’t exist on PyPI)docs/requirements.txt(instead of hardcoded installs)Test plan