#18448: Rename all documentation files to have .rst extension
-------------------------------------+-------------------------------------
Reporter: Marc Tamlyn | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 1.4
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mike Edmunds):
GitHub also supports `.rst.txt` extensions for rendering reStructuredText
source with previews and syntax highlighting:
https://github.com/medmunds/django/blob/rename-
docs/docs/intro/overview.rst.txt. That would address the concerns about
opening in text editors, so might be a reasonable compromise.
That said, I'd still argue for just going with `.rst` as the friendliest
for newcomers in online editors and IDEs. Neither PyCharm nor VS Code
recognize `.rst.txt` by default—they just open it as an ordinary text file
(and VS Code won't suggest installing a reST plugin). You can add file
type overrides to make it work, but if you've never heard of reST that
probably won't occur to you.
[I've also tried a
[https://github.com/django/django/pull/19279#issuecomment-2734378910
.gitattributes linguist override] on docs/!**.txt, with poor results.]
--
Ticket URL: <https://code.djangoproject.com/ticket/18448#comment:3>
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 view this discussion visit
https://groups.google.com/d/msgid/django-updates/01070195aacefc7f-f36c8478-31ec-4d83-b6d8-b1a6efcbb8d7-000000%40eu-central-1.amazonses.com.
