Skip to content
Projeler
Gruplar
Parçacıklar
Yardım
Yükleniyor...
Oturum aç / Kaydol
Gezinmeyi değiştir
D
django
Proje
Proje
Ayrıntılar
Etkinlik
Cycle Analytics
Depo (repository)
Depo (repository)
Dosyalar
Kayıtlar (commit)
Dallar (branch)
Etiketler
Katkıda bulunanlar
Grafik
Karşılaştır
Grafikler
Konular (issue)
0
Konular (issue)
0
Liste
Pano
Etiketler
Kilometre Taşları
Birleştirme (merge) Talepleri
0
Birleştirme (merge) Talepleri
0
CI / CD
CI / CD
İş akışları (pipeline)
İşler
Zamanlamalar
Grafikler
Paketler
Paketler
Wiki
Wiki
Parçacıklar
Parçacıklar
Üyeler
Üyeler
Collapse sidebar
Close sidebar
Etkinlik
Grafik
Grafikler
Yeni bir konu (issue) oluştur
İşler
Kayıtlar (commit)
Konu (issue) Panoları
Kenar çubuğunu aç
Batuhan Osman TASKAYA
django
Commits
460dab0b
Kaydet (Commit)
460dab0b
authored
Mar 15, 2016
tarafından
Tim Graham
Dosyalara gözat
Seçenekler
Dosyalara Gözat
İndir
Eposta Yamaları
Sade Fark
Removed obsolete section on "Improving the documentation".
üst
f2d9caa6
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
12 additions
and
55 deletions
+12
-55
new-contributors.txt
docs/internals/contributing/new-contributors.txt
+1
-2
writing-documentation.txt
docs/internals/contributing/writing-documentation.txt
+11
-53
No files found.
docs/internals/contributing/new-contributors.txt
Dosyayı görüntüle @
460dab0b
...
...
@@ -53,8 +53,7 @@ Start with these easy tasks to discover Django's development process.
Django's documentation is great but it can always be improved. Did you find
a typo? Do you think that something should be clarified? Go ahead and
suggest a documentation patch! See also the guide on
:doc:`writing-documentation`, in particular the tips for
:ref:`improving-the-documentation`.
:doc:`writing-documentation`.
.. note::
...
...
docs/internals/contributing/writing-documentation.txt
Dosyayı görüntüle @
460dab0b
...
...
@@ -193,12 +193,21 @@ documentation:
Add :mod:`django.contrib.auth` to your :setting:`INSTALLED_APPS`...
This is because Sphinx will generate proper links for the latter, which
greatly helps readers. There's basically no limit to the amount of
useful markup you can add.
greatly helps readers.
You can prefix the target with a ``~`` (that's a tilde) to get just the
"last bit" of that path. So ``:mod:`~django.contrib.auth``` will just
display a link with the title "auth".
* Use :mod:`~sphinx.ext.intersphinx` to reference Python's and Sphinx'
documentation.
* Add ``.. code-block:: <lang>`` to literal blocks so that they get
highlighted. Prefer relying on automatic highlighting simply using ``::``
(two colons). This has the benefit that if the code contains some invalid
syntax, it won't be highlighted. Adding ``.. code-block:: python``, for
example, will force highlighting despite invalid syntax.
* Use these heading styles::
===
...
...
@@ -415,57 +424,6 @@ example:
That's basically how everything fits together.
.. _improving-the-documentation:
Improving the documentation
===========================
A few small improvements can be made to make the documentation read and
look better:
* Most of the various ``index.txt`` documents have *very* short or even
non-existent intro text. Each of those documents needs a good short
intro the content below that point.
* The glossary is very perfunctory. It needs to be filled out.
* Add more metadata targets. Lots of places look like::
``File.close()``
~~~~~~~~~~~~~~~~
\... these should be::
.. method:: File.close()
That is, use metadata instead of titles.
* Whenever possible, use links. So, use ``:setting:`ADMINS``` instead
of ````ADMINS````.
* Use directives where appropriate. Some directives
(e.g. ``.. setting::``) are prefix-style directives; they go *before*
the unit they're describing. These are known as "crossref" directives.
Others (e.g. ``.. class::``) generate their own markup; these should go
inside the section they're describing. These are called
"description units".
You can tell which are which by looking at in
:file:`_ext/djangodocs.py`; it registers roles as one of the other.
* Add ``.. code-block:: <lang>`` to literal blocks so that they get
highlighted.
* When referring to classes/functions/modules, etc., you'll want to use
the fully-qualified name of the target
(``:class:`django.contrib.contenttypes.models.ContentType```).
Since this doesn't look all that awesome in the output -- it shows the
entire path to the object -- you can prefix the target with a ``~``
(that's a tilde) to get just the "last bit" of that path. So
``:class:`~django.contrib.contenttypes.models.ContentType``` will just
display a link with the title "ContentType".
.. _documentation-spelling-check:
Spelling check
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment