#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
-------------------------------------+-------------------------------------
Changes (by Adam Starrh):
* status: closed => new
* resolution: invalid =>
Comment:
Replying to [comment:3 Carlton Gibson]:
> This is not a support channel. Please see
TicketClosingReasons/UseSupportChannels.
>
> (Google `sphinx extensions`. Look in `django/docs/conf.py` and
`django/docs/_ext/djangodocs.py`)
>
> > This should be added to the documentation as well.
>
> We already link to the RST docs.
Please take a closer look at this.
To utilize the Django-Specific markup, developers must add "djangodocs",
to the extensions in their Sphinx configuration. The RST docs can tell you
where to add the extension, but Django's docs should at least tell you
what the name of the extension is, no?
https://docs.djangoproject.com/en/dev/internals/contributing/writing-
documentation/#getting-started-with-sphinx.
--
Ticket URL: <https://code.djangoproject.com/ticket/30607#comment:4>
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 [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/066.bc2e6781154edc877fde44c2fa3599c5%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
