We place a high importance on consistency and readability of documentation.\nAfter all, Django was created in a journalism environment! So we treat our\ndocumentation like we treat our code: we aim to improve it as often as\npossible.
\nDokumentasi berubah secara umum datang dalam dua bentuk:
\nPerbaikan umum: pembenaran kesalahan ketik, perbaikan kesalahan dan penjelasan lebih baik melalui penulisan lebih jelas dan lebih contoh.
Fitur baru: dokumentasi dari ditur yang telah ditambahkan ke kerangka kerja sejak terbitan terakhir.
This section explains how writers can craft their documentation changes\nin the most useful and least error-prone ways.
\nThough Django's documentation is intended to be read as HTML at\nhttps://docs.djangoproject.com/, we edit it as a collection of text files for\nmaximum flexibility. These files live in the top-level docs/ directory of a\nDjango release.
If you'd like to start contributing to our docs, get the development version of\nDjango from the source code repository\n(see Installing the development version). The development version has the\nlatest-and-greatest documentation, just as it has latest-and-greatest code.\nWe also backport documentation fixes and improvements, at the discretion of the\ncommitter, to the last release branch. That's because it's highly advantageous\nto have the docs for the last release be up-to-date and correct (see\nPerbedaan diantara versi).
\nDjango's documentation uses the Sphinx documentation system, which in turn\nis based on docutils. The basic idea is that lightly-formatted plain-text\ndocumentation is transformed into HTML, PDF, and any other output format.
\nTo actually build the documentation locally, you'll currently need to install\nSphinx -- pip install Sphinx should do the trick.
Kemudian, membangun HTML sangat mudah; cukup make html (atau make.bat html pada Windows) dari direktori docs.
Untuk mulai membantu, anda akan ingin membaca reStructuredText Primer. Setelah itu, anda akan ingin membaca tentang Sphinx-specific markup yang digunakan untuk mengelola meta data, pengindeksan, dan acuan-silang.
\nDokumentasi disusun kedalam beberapa kategori:
\nTutorials membawa pembaca dengan tangan melalui rangkaian langkah-langkah untuk membuat sesuatu.
\nHal terpenting dalam tutorial ini adalah membantu pembaca mendapatkan sesuatu berguna, lebih disukai seawal mungkin, agar memberikan mereka rasa nyaman.
\nExplain the nature of the problem we're solving, so that the reader\nunderstands what we're trying to achieve. Don't feel that you need to begin\nwith explanations of how things work - what matters is what the reader does,\nnot what you explain. It can be helpful to refer back to what you've done and\nexplain afterwards.
\nTopic guides bertujuan untuk menjelaskan konsep atau subjek pada tingkatan yang cukup tinggi.
\nLink to reference material rather than repeat it. Use examples and don't be\nreluctant to explain things that seem very basic to you - it might be the\nexplanation someone else needs.
\nMenyediakan konteks latar belakang membantu pendatang baru menghubungkan topik ke hal-hal yang mereka sudah ketahui.
\nReference guides mengandung acuan teknis untuk API. Mereka menggambarkan fungsi dari perlengkapan dalam Django dan petunjuk dalam penggunaannya.
\nKeep reference material tightly focused on the subject. Assume that the\nreader already understands the basic concepts involved but needs to know or\nbe reminded of how Django does it.
\nReference guides aren't the place for general explanation. If you find\nyourself explaining basic concepts, you may want to move that material to a\ntopic guide.
\nHow-to guides adalah resep yang membawa pembaca melalui langkah-langkah dalam subjek kunci.
\nWhat matters most in a how-to guide is what a user wants to achieve.\nA how-to should always be result-oriented rather than focused on internal\ndetails of how Django implements whatever is being discussed.
\nThese guides are more advanced than tutorials and assume some knowledge about\nhow Django works. Assume that the reader has followed the tutorials and don't\nhesitate to refer the reader back to the appropriate tutorial rather than\nrepeat the same material.
\nWhen using pronouns in reference to a hypothetical person, such as "a user with\na session cookie", gender neutral pronouns (they/their/them) should be used.\nInstead of:
\ndia laki-laki atau dia perempuan... gunakan mereka
dia laki-laki atau dia perempuan... gunakan mereka
dia laki-laki atau dia perempuan... gunakan mereka
dia laki-laki atau dia perempuan... gunakan mereka
dia laki-laki atau dia perempuan... gunakan mereka
Ini adalah beberapa panduan pada istilah paling umum digunakan sepanjang dokumentasi:
\nDjango -- ketika mengacukan ke kerangka kerja, huruf besarkan Django. Huruf kecil hanya dalam kode Python dan dalam logo djangoproject.com.
email -- tanpa tanda penghubung
MySQL, PostgreSQL, SQLite
SQL -- when referring to SQL, the expected pronunciation should be\n"Ess Queue Ell" and not "sequel". Thus in a phrase like "Returns an\nSQL expression", "SQL" should be preceded by "an" and not "a".
Python -- when referring to the language, capitalize Python.
realize, customize, initialize, etc. -- use the American\n"ize" suffix, not "ise."
subclass -- it's a single word without a hyphen, both as a verb\n("subclass that model") and as a noun ("create a subclass").
Web, World Wide Web, the Web -- note Web is always\ncapitalized when referring to the World Wide Web.
website -- gunakan satu kata, tanpa huruf besar.
model -- itu tidak huruf besar.
template -- itu tidak huruf besar.
URLconf -- gunakan tiga huruf besar, tanpa ruang sebelum "conf."
view -- itu tidak huruf besar.
Panduan ini mengatur bentuk dari dokumentasi dari reST (reStructuredText) kami:
\nIn section titles, capitalize only initial words and proper nouns.
Wrap the documentation at 80 characters wide, unless a code example\nis significantly less readable when split over two lines, or for another\ngood reason.
The main thing to keep in mind as you write and edit docs is that the\nmore semantic markup you can add the better. So:
\nAdd ``django.contrib.auth`` to your ``INSTALLED_APPS``...\nIsn't nearly as helpful as:
\nAdd :mod:`django.contrib.auth` to your :setting:`INSTALLED_APPS`...\nThis is because Sphinx will generate proper links for the latter, which\ngreatly helps readers. There's basically no limit to the amount of\nuseful markup you can add.
\nGunakan intersphinx untuk mengacu dokumentasi Python and Sphinx'.
Gunakan gaya kepala ini:
\n===\nOne\n===\n\nTwo\n===\n\nThree\n-----\n\nFour\n~~~~\n\nFive\n^^^^\nBesides the Sphinx built-in markup, Django's\ndocs defines some extra description units:
\nPengaturan:
\n.. setting:: INSTALLED_APPS\nTo link to a setting, use :setting:`INSTALLED_APPS`.
Cetakan etiket:
\n.. templatetag:: regroup\nUntuk mengkaitkan, gunakan :ttag:`regroup`.
Cetakan penyaring:
\n.. templatefilter:: linebreaksbr\nTo link, use :tfilter:`linebreaksbr`.
Field lookups (i.e. Foo.objects.filter(bar__exact=whatever)):
.. fieldlookup:: exact\nUntuk mengkaitkan, gunakan :lookup:`exact`.
Perintah django-admin:
.. django-admin:: migrate\nUntuk mengkaitkan, gunakan :djadmin:`migrate`.
Pilihan baris-perintah django-admin:
.. django-admin-option:: --traceback\nTo link, use :option:`command_name --traceback` (or omit command_name\nfor the options shared by all commands like --verbosity).
Links to Trac tickets (typically reserved for patch release notes):
\n:ticket:`12345`\nKebijakan kami untuk fitur baru adalah:
\n\n\nAll documentation of new features should be written in a way that\nclearly designates the features are only available in the Django\ndevelopment version. Assume documentation readers are using the latest\nrelease, not the development version.
\n
Our preferred way for marking new features is by prefacing the features'\ndocumentation with: ".. versionadded:: X.Y", followed by a mandatory\nblank line and an optional description (indented).
General improvements, or other changes to the APIs that should be emphasized\nshould use the ".. versionchanged:: X.Y" directive (with the same format\nas the versionadded mentioned above.
These versionadded and versionchanged blocks should be "self-contained."\nIn other words, since we only keep these annotations around for two releases,\nit's nice to be able to remove the annotation and its contents without having\nto reflow, reindent, or edit the surrounding text. For example, instead of\nputting the entire description of a new or changed feature in a block, do\nsomething like this:
.. class:: Author(first_name, last_name, middle_name=None)\n\n A person who writes books.\n\n ``first_name`` is ...\n\n ...\n\n ``middle_name`` is ...\n\n .. versionchanged:: A.B\n\n The ``middle_name`` argument was added.\nPut the changed annotation notes at the bottom of a section, not the top.
\nAlso, avoid referring to a specific version of Django outside a\nversionadded or versionchanged block. Even inside a block, it's often\nredundant to do so as these annotations render as "New in Django A.B:" and\n"Changed in Django A.B", respectively.
If a function, attribute, etc. is added, it's also okay to use a\nversionadded annotation like this:
.. attribute:: Author.middle_name\n\n .. versionadded:: A.B\n\n An author's middle name.\nWe can simply remove the .. versionadded:: A.B annotation without any\nindentation changes when the time comes.
Optimize image compression where possible. For PNG files, use OptiPNG and\nAdvanceCOMP's advpng:
$ cd docs/\n$ optipng -o7 -zm1-9 -i0 -strip all `find . -type f -not -path "./_build/*" -name "*.png"`\n$ advpng -z4 `find . -type f -not -path "./_build/*" -name "*.png"`\nThis is based on OptiPNG version 0.7.5. Older versions may complain about the\n--strip all option being lossy.
For a quick example of how it all fits together, consider this hypothetical\nexample:
\nFirst, the ref/settings.txt document could have an overall layout\nlike this:
========\nSettings\n========\n\n...\n\n.. _available-settings:\n\nAvailable settings\n==================\n\n...\n\n.. _deprecated-settings:\n\nDeprecated settings\n===================\n\n...\nNext, the topics/settings.txt document could contain something like\nthis:
You can access a :ref:`listing of all available settings\n<available-settings>`. For a list of deprecated settings see\n:ref:`deprecated-settings`.\n\nYou can find both in the :doc:`settings reference document\n</ref/settings>`.\nWe use the Sphinx doc cross reference element when we want to\nlink to another document as a whole and the ref element when\nwe want to link to an arbitrary location in a document.
Next, notice how the settings are annotated:
\n.. setting:: ADMINS\n\nADMINS\n======\n\nDefault: ``[]`` (Empty list)\n\nA list of all the people who get code error notifications. When\n``DEBUG=False`` and a view raises an exception, Django will email these people\nwith the full exception information. Each member of the list should be a tuple\nof (Full name, email address). Example::\n\n [('John', 'john@example.com'), ('Mary', 'mary@example.com')]\n\nNote that Django will email *all* of these people whenever an error happens.\nSee :doc:`/howto/error-reporting` for more information.\nThis marks up the following header as the "canonical" target for the\nsetting ADMINS. This means any time I talk about ADMINS,\nI can reference it using :setting:`ADMINS`.
That's basically how everything fits together.
\nSedikit perbaharuan kecil dapat dibuat untuk membuat dokumentasi dibaca dan kelihatan lebih baik:
\nMost of the various index.txt documents have very short or even\nnon-existent intro text. Each of those documents needs a good short\nintro 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:
\n``File.close()``\n~~~~~~~~~~~~~~~~\n... ini seharusnya menjadi:
\n.. method:: File.close()\nYaitu, gunakan metadata daripada judul.
\nJika memungkinkan, gunakan kaitan. Jadi gunakan :setting:`ADMINS` daripada ``ADMINS``.
Use directives where appropriate. Some directives\n(e.g. .. setting::) are prefix-style directives; they go before\nthe unit they're describing. These are known as "crossref" directives.\nOthers (e.g. .. class::) generate their own markup; these should go\ninside the section they're describing. These are called\n"description units".
You can tell which are which by looking at in\n_ext/djangodocs.py; it registers roles as one of the other.
Add .. code-block:: <lang> to literal blocks so that they get\nhighlighted.
When referring to classes/functions/modules, etc., you'll want to use\nthe fully-qualified name of the target\n(:class:`django.contrib.contenttypes.models.ContentType`).
Since this doesn't look all that awesome in the output -- it shows the\nentire path to the object -- you can prefix the target with a ~\n(that's a tilde) to get just the "last bit" of that path. So\n:class:`~django.contrib.contenttypes.models.ContentType` will just\ndisplay a link with the title "ContentType".
Before you commit your docs, it's a good idea to run the spelling checker.\nYou'll need to install a couple packages first:
\nThen from the docs directory, run make spelling. Wrong words (if any)\nalong with the file and line number where they occur will be saved to\n_build/spelling/output.txt.
If you encounter false-positives (error output that actually is correct), do\none of the following:
\nSurround inline code or brand/technology names with grave accents (`).
Find synonyms that the spell checker recognizes.
If, and only if, you are sure the word you are using is correct - add it\nto docs/spelling_wordlist (please keep the list in alphabetical order).
See Localizing the Django documentation if\nyou'd like to help translate the documentation into another language.
\ndjango-admin man pageLink to this heading#Sphinx can generate a manual page for the\ndjango-admin command. This is configured in\ndocs/conf.py. Unlike other documentation output, this man page should be\nincluded in the Django repository and the releases as\ndocs/man/django-admin.1. There isn't a need to update this file when\nupdating the documentation, as it's updated once as part of the release process.
To generate an updated version of the man page, run make man in the\ndocs directory. The new man page will be written in\ndocs/_build/man/django-admin.1.