Repository navigation
Renewing perception metrics documentation #596
Description
The current documentation is split between the human-readable docs at https://jderobot.github.io/PerceptionMetrics/ and the docstring-driven API docs at https://jderobot.github.io/PerceptionMetrics/py_docs/build/html/index.html.
Combining these into a clearer documentation structure would make it easier for users to find guides for datasets, models, CLI usage, metrics, and data formats, while still keeping the detailed Python API reference available.
Reference style:
https://carla.readthedocs.io/en/latest/python_api/
Metadata
Metadata
Assignees
Labels
No labels
Activity
sanket-jadhav-cse commentedon Jun 18, 2026
Hello!
It would be great if you allow me to handle this problem.
I will go through the existing documents and try to make some changes in terms of their organization. Could you please provide me with any guidelines prior to that?
tejasstanley commentedon Sep 26, 2026
Hi @sanket-jadhav-cse thanks for your interest in the project! Could you first share a brief proposal outlining how you would approach this issue and what your next steps would be? In particular, it would be useful to understand how you plan to reorganize the existing documentation and integrate the API reference.
You can also refer to the CONTRIBUTING.md for the project guidelines.
sanket-jadhav-cse commentedon Sep 27, 2026
Hi @tejasstanley , thanks for the guidance. I reviewed the current Jekyll/Sphinx docs and
CONTRIBUTING.md.I’m planning to reorganize them into:
I’ll improve the navigation and cross-links while keeping the current Sphinx API workflow. I’ll mainly update
docs/_pages/,docs/_data/navigation.yml, anddocs/py_docs/source/index.rst, then build both docs and verify the links.I’ll keep the PR focused on #596. Does this structure match what you had in mind?
aroraanushri commentedon Sep 28, 2026
Building on @sanket-jadhav-cse’s proposed structure, I’d suggest a few additions to connect the guides and API reference more:
For an initial PR, I’d focus on replacing the placeholder content in
docs/py_docs/source/index.rstwith an API landing page and connecting it to one end-to-end image-detection tutorial. I’d retain the existing Jekyll/Sphinx workflow, preserve existing URLs, and verify both documentation builds.Since Sanket is already proposing the overall reorganization, I’d be happy to coordinate and take ownership of the tutorial and guide–API integration.
tejasstanley commentedon Sep 29, 2026
Hi @sanket-jadhav-cse, the proposed structure looks good. I’ll assign #596 to you, please go ahead with this approach.
tejasstanley commentedon Sep 29, 2026
Hi @aroraanushri, thanks for the suggestions. Since #596 will be assigned to Sanket, could you please open a separate issue for these additions and link #596 there for context?
We are already covering the basic tutorials for all the tasks supported in PerceptionMetrics, so I’d recommend going through the existing tutorials first. We probably won’t need another end-to-end evaluation tutorial for the time being.
The guide–API linking and data-format documentation could still be useful to explore in the separate issue.
sanket-jadhav-cse commentedon Sep 29, 2026
Opened PR #646 for issue #596 with the approved documentation reorganization and validation completed.