Open onegreyonewhite opened 2 weeks ago
pawamoy
commented
2 weeks ago This change enables mkdocstrings, but does not actually use it to render API docs. So nothing will be added to the objects.inv file, unfortunately. In short, this change is not enough to achieve what you want.
onegreyonewhite
commented
2 weeks ago @pawamoy yep, you're right. I added links to actual documentation. It's better then nothing but I think whole documentation should be rewrited. But it just a first step.
tomchristie
commented
2 weeks ago The light touch approach to this would be to add an objects.inv directly. No tooling changes.
onegreyonewhite
commented
2 weeks ago The light touch approach to this would be to add an
objects.invdirectly. No tooling changes.
@tomchristie If you have an idea on how to implement this so that it's easy to maintain later, I'm all ears. In this approach, all the manual work comes down to adding links to classes directly in the documentation. This way, there's no need to worry about changing header names—the link will point precisely to the section that reflects the description.
Description
This pull request enhances the Django REST Framework documentation by configuring it to generate an
objects.invfile throughmkdocstrings-python. This file allows for integration withintersphinx, enabling references to DRF documentation from other Sphinx-based documentation projects, which supports better cross-referencing and linking across Python documentation.This change addresses feedback from the community discussion here, where users expressed the need for smoother integration with other projects' documentation. By generating
objects.inv, we can facilitate seamless linking and improve the usability of DRF documentation in broader documentation ecosystems.No open issues directly reference this feature, but this enhancement aligns with ongoing efforts to improve DRF's documentation flexibility and integration capabilities.