Opened 5 years ago
Last modified 5 years ago
#30607 closed Cleanup/optimization
How to use Django specific markup in the docstrings. — at Initial Version
Reported by: | Anuj Sharma | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | 2.2 |
Severity: | Normal | Keywords: | writing-documentation, Django-specific-markup |
Cc: | Triage Stage: | Unreviewed | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
I am using Sphinx to generate documentation from the docstrings defined in the modes, view, etc files.
At a few places, I have used Django specific markup for creating reference link. Same is documented in the [writing-documentation](https://docs.djangoproject.com/en/dev/internals/contributing/writing-documentation/#django-specific-markup)
Ex.
The length is defined in the :setting:`URL_ID_LENGTH`
But while generating the documentation using
make html,
it gives an error as
:docstring of app.models.Class.function:4: WARNING: Unknown interpreted text role "setting".
How to use the Django specific markups? This should be added to the documentation as well.
Here is an issue on StackOverflow: https://stackoverflow.com/q/56803854/3719167