We place high importance on the 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.
\n문서 변경은 다음 두 가지 형태로 이뤄집니다.
\n일반적인 개선: 오탈자 수정, 명료한 문장과 더 많은 예제를 통한 오류 수정 및 예제 개선.
새로운 기능: 최종 릴리스 이후에 프레임워크에 추가된 기능에 대한 문서화.
이 절에서는 저자들이 어떻게 유용하고도 오류를 적게 일으키는 방식으로 문서 변경을 다루는지 설명합니다.
\nThough Django’s documentation is intended to be read as HTML at\nhttps://docs.djangoproject.com/, we edit it as a collection of plain text files\nwritten in the reStructuredText markup language for maximum flexibility.
\nWe work from the development version of the repository because it has the\nlatest-and-greatest documentation, just as it has the latest-and-greatest code.
\nWe also backport documentation fixes and improvements, at the discretion of the\nmerger, to the last release branch. This is because it’s advantageous to\nhave the docs for the last release be up-to-date and correct (see\n버전 간 차이점).
\nDjango 문서는 docutils를 기반으로 하는 Sphinx 문서화 시스템을 사용합니다. Sphinx는 가벼운 형식의 일반 텍스트 문서를 HTML, PDF, 기타 여러 형식으로 변환해줍니다.
\nSphinx includes a sphinx-build command for turning reStructuredText into\nother formats, e.g., HTML and PDF. This command is configurable, but the Django\ndocumentation includes a Makefile that provides a shorter make html\ncommand.
문서는 여러 범주로 나뉩니다.
\n튜토리얼은 독자로 하여금 차근차근 따라 하면서 뭔가 만들어 볼 수 있도록 해줍니다.
\n튜토리얼에서 가장 중요한 것은 독자가 최대한 빠르게 유용한 것을 만들어 봄으로써 자신감을 갖도록 하는 것입니다.
\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 afterward.
\n주제 가이드는 개념 또는 주제를 고수준에서 설명하는 것을 목적으로 합니다.
\n참고 자료에 있는 내용을 반복하지 말고 링크를 거세요. 예제를 사용하고, 매우 기초적인 내용에 대한 설명을 아끼지 마세요. 그런 설명을 필요로 하는 사람이 있을 지 모릅니다.
\n해당 주제를 처음 접하는 사람들을 위해 배경 지식을 설명하는 것은 그들이 이미 알고 있는 것과 연결하는 데 도움이 됩니다.
\nReference guides contain technical references for APIs.\nThey describe the functioning of Django’s internal machinery and instruct in\nits use.
\n참고 자료는 주제에 집중해야 합니다. 독자가 이미 기본 개념을 알고 있되 Django에서 그것을 어떻게 다루는지에 대한 설명이 필요할 것으로 가정하세요.
\n참조 가이드는 일반적인 설명을 위한 것이 아닙니다. 기본 개념에 대해 설명하고 있다고 느껴지면, 그것을 주제 가이드로 옮기기 바랍니다.
\nHow-to 가이드는 주요한 주제에 있어서 독자가 따라할 수 있는 레시피입니다.
\nhow-to 가이드에서는 사용자가 달성하고자 하는 것이 중요합니다. how-to에서는 Django의 내부 구현에 대한 세부 사항보다는 결과물을 도출하는 데 집중해야 합니다.
\nhow-to 가이드는 튜토리얼보다 수준이 높으며, 독자가 Django의 동작 원리에 대한 지식이 있을 것으로 간주합니다. 독자가 이미 튜토리얼을 읽은 것으로 간주하고, 같은 내용을 반복하지 말고 관련 튜토리얼에 대한 참조를 제공하세요.
\nIf you’d like to start contributing to our docs, get the development version of\nDjango from the source code repository (see\nInstalling the development version):
\nLinux / macOS
$ git clone https://github.com/django/django.git\nWindows
...\\> git clone https://github.com/django/django.git\nIf you’re planning to submit these changes, you might find it useful to make a\nfork of the Django repository and clone this fork instead.
\nCreate and activate a virtual environment, then install the dependencies:
\n$ python -m venv .venv\n$ source .venv/bin/activate\n$ python -m pip install -r docs/requirements.txt\nWe can build HTML output from the docs directory:
Linux / macOS
$ cd docs\n$ make html\nWindows
...\\> cd docs\n...\\> make.bat html\nYour locally-built documentation will be accessible at\n_build/html/index.html and it can be viewed in any web browser, though it\nwill be themed differently than the documentation at\ndocs.djangoproject.com. This is OK! If\nyour changes look good on your local machine, they’ll look good on the website.
The source files are .txt files located in the docs/ directory.
These files are written in the reStructuredText markup language. To learn the\nmarkup, see the reStructuredText reference.
\nTo edit this page, for example, we would edit the file\ndocs/internals/contributing/writing-documentation.txt and rebuild the\nHTML with make html.
Before you commit your docs, it’s a good idea to run the spelling checker.\nYou’ll need to install sphinxcontrib-spelling first. Then from the\ndocs directory, run make spelling. Wrong words (if any) along with the\nfile and line number where they occur will be saved to\n_build/spelling/output.txt.
False Positive(실제로 정확한 오류 출력)가 발생하는 경우 다음 중 하나를 수행합니다.
\nSurround inline code or brand/technology names with double grave accents\n(``).
철자 검사기가 인식하는 동의어를 찾습니다.
사용 중인 단어가 정확하다고 확신하는 경우에만 “docs/spelling_wordlist”에 추가합니다(목록은 알파벳 순으로 유지).
설명서의 링크는 더 이상 표준 링크가 아니도록 손상되거나 변경될 수 있습니다. 스핑크스는 설명서의 링크가 작동하는지 확인할 수 있는 작성기를 제공합니다. “docs” 디렉토리에서 “make link check”를 실행합니다. 출력은 터미널에 인쇄되지만 _build/linkcheck/output.txt 및 ‘’_build/link check/output.json’’에서도 확인할 수 있습니다.
상태가 “작동 중”인 항목은 정상이며, “선택 취소됨” 또는 “무시됨” 항목은 확인할 수 없거나 구성의 무시 규칙과 일치하기 때문에 건너뜁니다.
\nEntries that have a status of “broken” need to be fixed. Those that have a\nstatus of “redirected” may need to be updated to point to the canonical\nlocation, e.g. the scheme has changed http:// → https://. In certain\ncases, we do not want to update a “redirected” link, e.g. a rewrite to always\npoint to the latest or stable version of the documentation, e.g. /en/stable/ →\n/en/3.2/.
When 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:
\nhe 또는 she 대신 they를 사용합니다.
him 또는 her 대신 them을 사용합니다.
his 또는 her 대신 their를 사용합니다.
his 또는 hers 대신 theirs를 사용합니다.
himself 또는 herself 대신 themselves를 사용합니다.
Try to avoid using words that minimize the difficulty involved in a task or\noperation, such as “easily”, “simply”, “just”, “merely”, “straightforward”, and\nso on. People’s experience may not match your expectations, and they may become\nfrustrated when they do not find a step as “straightforward” or “simple” as it\nis implied to be.
\n다음은 문서에서 공통적으로 사용되는 용어에 대한 지침입니다.
\nDjango – 프레임워크를 지칭할 때에는 첫 글자를 대문자로 하여 Django로 표기합니다. Python 코드와 djangoproject.com 로고에서만 소문자를 사용합니다.
email – 하이픈을 넣지 않습니다.
HTTP – the expected pronunciation is “Aitch Tee Tee Pee” and therefore\nshould be preceded by “an” and not “a”.
MySQL, PostgreSQL, SQLite
SQL – SQL을 가리킬 때, 그 발음은 “시퀄”이 아니라 “에스큐엘”로 합니다. 따라서 “Returns an SQL expression”과 같은 표현에서 “SQL” 앞에는 “a”가 아닌 “an”이 옵니다.
Python – 언어를 가리킬 때에는 첫 글자를 대문자로 하여 Python으로 표기합니다.
realize, customize, initialize 등. – 미국식으로 “ize”를 붙이며, “ise”는 붙이지 않습니다.
subclass – 하이픈이 없는 하나의 단어로, 동사(“subclass that model”) 또는 명사(“create a subclass”)입니다.
the web, web framework – it’s not capitalized.
website – 대문자 없이 한 단어로 씁니다.
model – 대문자가 아닙니다.
template – 대문자가 아닙니다.
URLconf – 처음 세 글자를 대문자로 하며, “conf”와의 사이에 공백을 두지 않습니다.
view – 대문자가 아닙니다.
These guidelines regulate the format of our reST (reStructuredText)\ndocumentation:
\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.
\nYou can prefix the target with a ~ (that’s a tilde) to get only the\n“last bit” of that path. So :mod:`~django.contrib.auth` will\ndisplay a link with the title “auth”.
All Python code blocks should be formatted using the blacken-docs\nauto-formatter. This will be run by pre-commit if that is configured.
Use intersphinx to reference Python’s and Sphinx’\ndocumentation.
Add .. code-block:: <lang> to literal blocks so that they get\nhighlighted. Prefer relying on automatic highlighting using ::\n(two colons). This has the benefit that if the code contains some invalid\nsyntax, it won’t be highlighted. Adding .. code-block:: python, for\nexample, will force highlighting despite invalid syntax.
To improve readability, use .. admonition:: Descriptive title rather than\n.. note::. Use these boxes sparingly.
Use these heading styles:
\n===\nOne\n===\n\nTwo\n===\n\nThree\n-----\n\nFour\n~~~~\n\nFive\n^^^^\nUse :rfc: to reference RFC and try to link to the relevant\nsection if possible. For example, use :rfc:`2324#section-2.3.2` or\n:rfc:`Custom link text <2324#section-2.3.2>`.
Use :pep: to reference a Python Enhancement Proposal (PEP)\nand try to link to the relevant section if possible. For example, use\n:pep:`20#easter-egg` or :pep:`Easter Egg <20#easter-egg>`.
Use :mimetype: to refer to a MIME Type unless the value\nis quoted for a code example.
Use :envvar: to refer to an environment variable. You may\nalso need to define a reference to the documentation for that environment\nvariable using .. envvar::.
Besides Sphinx’s built-in markup, Django’s docs\ndefine some extra description units:
\nSettings:
\n.. setting:: INSTALLED_APPS\n설정에 연결하려면 :setting:`INSTALLED_APPS` 을 사용하십시오.
Template tags:
\n.. templatetag:: regroup\nTemplate filters:
\n.. templatefilter:: linebreaksbr\n연결하려면``:tfilter:`linebreaksbr```를 이용하십시오.
\nField lookups (i.e. Foo.objects.filter(bar__exact=whatever)):
.. fieldlookup:: exact\n연결하려면````:lookup:`exact``````를 이용하십시오.
\ndjango-admin commands:
.. django-admin:: migrate\n연결하려면``:djadmin:`migrate```를 이용하십시오.
\ndjango-admin command-line options:
.. 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`\n장고의 문서에는 “장고-admin”, “관리”와 관련된 명령줄 예를 문서화하기 위해 사용자 정의 “콘솔” 지시문이 사용된다.py``, python, etc.). HTML 문서에서는 두 탭 UI를 렌더링하며, 한 탭은 유닉스 스타일의 명령 프롬프트를, 두 번째 탭은 윈도우 프롬프트를 보여준다.
For example, you can replace this fragment:
\nuse this command:\n\n.. code-block:: console\n\n $ python manage.py shell\nwith this one:
\nuse this command:\n\n.. console::\n\n $ python manage.py shell\n다음 두 가지를 주목하십시오.
\n일반적으로 .. code-block:: console 지시문의 항목을 대체합니다.
You don’t need to change the actual content of the code example. You still\nwrite it assuming a Unix-y environment (i.e. a '$' prompt symbol,\n'/' as filesystem path components separator, etc.)
위의 예제에서는 두 개의 탭이 있는 코드 예제 블록을 렌더링합니다. 첫 번째 항목은 다음과 같습니다.
\n$ python manage.py shell\n(``.. code-block:: console``에서 렌더링한 변경 사항은 없습니다.)
\n두 번째 항목은 다음과 같습니다.
\n...\\> py manage.py shell\n새로운 기능에 대한 당사의 정책은 다음과 같습니다.
\n\n\nAll documentation of new features should be written in a way that\nclearly designates the features that 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.\n변경된 주석 노트를 맨 위가 아닌 섹션 맨 아래에 배치합니다.
\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 remove the .. versionadded:: A.B annotation without any indentation\nchanges when the time comes.
가능한 경우 이미지 압축을 최적화합니다. PNG 파일의 경우 OptiPNG 및 Advanced를 사용합니다.COMP의 ‘’advpng’’:
\n$ 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"`\n이 버전은 OptiPNG 버전 0.7.5를 기반으로 합니다. 구 버전에서는 “-스트라이프 올” 옵션이 상실되는 것에 대해 불평할 수도 있습니다.
\n이 모든 것이 어떻게 서로 들어맞는지에 대한 간단한 예제를 보려면 다음 가상 예를 고려해 보십시오.
\n먼저 ‘’참조/설정’’입니다.txt document 문서의 전체 레이아웃은 다음과 같습니다.
\n========\nSettings\n========\n\n...\n\n.. _available-settings:\n\nAvailable settings\n==================\n\n...\n\n.. _deprecated-settings:\n\nDeprecated settings\n===================\n\n...\n다음은 ‘’주제/설정’’입니다.txt 문서에는 다음과 같은 내용이 포함될 수 있습니다.
\nYou 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.
그런 다음 설정에 주석을 달 수 있습니다.
\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`.
기본적으로 모든 것이 서로 맞아떨어집니다.
\n참조:ref:문서를 다른 언어로 번역하려면 “장고 문서 현지화”를 참조하십시오.
\nSphinx 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.
man 페이지의 업데이트된 버전을 생성하려면 “docs” 디렉토리에서 “make man”을 실행하십시오. 새 맨 페이지는 ‘’docs/_build/man/django-admin’’으로 작성될 예정입니다.1``.
\n