You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I started using mkdocs with mkdocstrings [1] and it has the ability to import objects.inv (see intersphinx) files to reference elements from other projects. Unfortunately, DRF does not provide this file.
I am aware that you are using mkdocs and the aforementioned mkdocstrings actually generates the objects.inv file. So I am wondering whether there is interest to provide this. It would be great to be able to reference a code element in docstrings and have it link automatically to the relevant part in the DRF documentation.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
I started using
mkdocs
withmkdocstrings
[1] and it has the ability to importobjects.inv
(see intersphinx) files to reference elements from other projects. Unfortunately, DRF does not provide this file.I am aware that you are using
mkdocs
and the aforementionedmkdocstrings
actually generates theobjects.inv
file. So I am wondering whether there is interest to provide this. It would be great to be able to reference a code element in docstrings and have it link automatically to the relevant part in the DRF documentation.[1] https://mkdocstrings.github.io/
Beta Was this translation helpful? Give feedback.
All reactions