#30607: How to use Django specific markup in the docstrings.
-------------------------------------+-------------------------------------
Reporter: Anuj Sharma | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 2.2
Severity: Normal | Resolution:
Keywords: writing- | Triage Stage:
documentation, Django-specific- | Unreviewed
markup |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Description changed by Anuj Sharma:
Old description:
> I am using Sphinx to generate documentation from the docstrings defined
> in the models, views, 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
New description:
I am using Sphinx to generate documentation from the docstrings defined in
the models, views, 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
--
--
Ticket URL: <https://code.djangoproject.com/ticket/30607#comment:2>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/066.76c45af4eb69420bb8c6cf865a8abf3d%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
