Рубрики
Без рубрики

Как документировать ваш проект Django с помощью инструмента SPHINX

Автор оригинала: Goran Aviani.

Недавно я посетил компанию, где у меня приятно поговорить с одним из своих сотрудников. Мы говорили о технологиях и программировании. Затем мы коснулись предмета проектной документации. В частности, насколько реагируют автоматически, но django не. Это заставило меня думать, что я должен сделать автоматическую документацию для моих проектов Django.

Я не мог найти какую-либо соответствующую документацию о том, как она сделана, поэтому мне потребовалось немного дольше, чем я изначально планировал. Не потому, что это было тяжело, но потому что я обнаружил, что официальная документация Sphinx и другие ресурсы для устаревших или неясных.

Итак, сегодня я сделал простое, но всеобъемлющее учебное пособие, которое объясняет, как сделать Django Documentation, используя инструмент документации SPHINX в Ubuntu.

Установить Сфинкс

Сначала вы должны войти в виртуальную среду для вашего проекта Django.

Установка SPHINX довольно прост, используя PIP3 (PIP для Python 3):

pip3 install sphinx

Создать каталог документации

После установки SPHINX вам нужно будет создать корневую папку документов. Эта папка проверит вашу документацию и другие файлы, которые вам понадобится (изображения, о страницах и так далее …).

Создайте папку Root Document в основной папке проекта и назовите его/Docs.

Чтобы запустить SPHINX, запустите эту команду в папке/Docs:

sphinx-quickstart

Теперь у вас будет много вариантов. В большинстве случаев вы можете просто передать опцию по умолчанию, но есть некоторые варианты, на которые вам нужно обратить внимание.

Вот как я отвечал:

Welcome to the Sphinx 1.7.5 quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Selected root path: .

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.

> Separate source and build directories (y/n) [n]: n

Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.

> Name prefix for templates and static dir [_]: _

The project name will occur in several places in the built documentation.
> Project name: Your_project_name
> Author name(s): Goran Aviani
> Project release []: 1.0

If the documents are to be written in a language other than English,
you can select a language here by its language code. Sphinx will then
translate text that it generates into that language.

For a list of supported codes, see
http://sphinx-doc.org/config.html#confval-language.

> Project language [en]: en

The file name suffix for source files. Commonly, this is either ".txt"
or ".rst". Only files with this suffix are considered documents.

> Source file suffix [.rst]: .rst

One document is special in that it is considered the top node of the
"contents tree", that is, it is the root of the hierarchical structure
of the documents. Normally, this is "index", but if your "index"
document is a custom template, you can also set this to another filename.

> Name of your master document (without suffix) [index]: index

Sphinx can also add configuration for epub output:

> Do you want to use the epub builder (y/n) [n]: n

Indicate which of the following Sphinx extensions should be enabled:

> autodoc: automatically insert docstrings from modules (y/n) [n]: y
> doctest: automatically test code snippets in doctest blocks (y/n) [n]: y
> intersphinx: link between Sphinx documentation of different projects (y/n) [n]: n
> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]: y
> coverage: checks for documentation coverage (y/n) [n]: y
> imgmath: include math, rendered as PNG or SVG images (y/n) [n]: y
> mathjax: include math, rendered in the browser by MathJax (y/n) [n]: n
> ifconfig: conditional inclusion of content based on config values (y/n) [n]: n
> viewcode: include links to the source code of documented Python objects (y/n) [n]: n
> githubpages: create .nojekyll file to publish the document on GitHub pages (y/n) [n]: n
A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. `make html' instead of invoking sphinx-build
directly.
> Create Makefile? (y/n) [y]: y
> Create Windows command file? (y/n) [y]: y

Creating file ./conf.py.
Creating file ./index.rst.
Creating file ./Makefile.
Creating file ./make.bat.

Finished: An initial directory structure has been created.

You should now populate your master file ./index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:

make builder

where "builder" is one of the supported builders, e.g. html, latex or linkcheck.

Django Connection

В вашей папке проекта найдите/docs/conf.py и внутри него, где-то рядом с верхней частью файла, найдите «#» ОС “. Чутьму ниже это, напишите это:

import os
import sys
import django
sys.path.insert(0, os.path.abspath('..'))
os.environ['DJANGO_SETTINGS_MODULE'] = 'Your_project_name.settings'
django.setup()

Теперь есть два способа продолжить:

  1. Вы можете использовать Сфинкс-apidoc Создать полностью автоматическую документацию или
  2. Вы можете построить свои собственные модули, которые покажут в документации.

В этом руководстве я собираюсь показать вам, как сделать это оба.

1. Сфинкс-апидок

Это более простой метод, где вам просто нужно перейти к папке/Docs и выполнить:

sphinx-apidoc -o . ..

Теперь вам нужно создать свою документацию, запустив команду:

make html

Перейдите к Your_project_folder/docs/_build/html и открыть index.html. Это индексная страница вашей документации.

2. Создание собственных модулей

Это немного более сложный способ, но даст вам гораздо больше свободы в организации вашей документации.

Теперь вы хотите сделать документацию о ваших представлениях, модулях и т. Д. Но сначала позвольте мне показать вам простой пример, просто вы понимаете логику этой части:

Перейдите в папку/Docs и создайте новую папку с именем «/модули». Внутри он создает файл с именем All-about-me.rst:

mkdir modulesf
touch modules/all-about-me.rst

Внутри все-о-me.rst напишите что-то подобное:

############
All about me
############

I'm Goran Aviani, a Django developer.

Теперь вы создали что-то, чтобы показать в вашей документации, но все же у вас нет фактического места, чтобы показать его. Вернитесь к папке/Docs и откройте index.rst и просто позвоните в этот код

.. toctree::
   :maxdepth: 2
   :caption: Contents:

Добавь это:

modules/all-about-me.rst

Сделайте это, чтобы между верхним кодом и добавленной строкой есть пустая строка:

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules/all-about-me.rst

Теперь вам нужно создать свою документацию. Измените местоположение в папку, содержащую makefile (то есть папка/docs). Затем запустите в терминале:

make html

Вы найдете свою документацию в

Вы можете сделать то же самое для ваших видов Django:

Внутри папки/модулей создайте файл Views.rst.

touch views.rst

Внутри Views.rst File Написать это:

Views
======

.. automodule:: yourapp.views
   :members:
   :undoc-members:

Внутри index.rst, просто под модулями/все-о-me.rst, добавьте это:

modules/views.rst

Теперь вы снова должны построить свою документацию, запустив «Сделайте HTML» в папке ваших/доксов:

make html

Получить идею? Сначала вы создаете файл.

Вы можете сделать то же самое для ваших моделей. Перейдите в папку/модулях и создайте файл models.rst.

touch models.rst

Вы можете добавить что-то вроде этого в ваших моделях.

Models
=======

.. automodule:: yourapp.models
   :members:
   :undoc-members:

Внутри index.rst только под модулями/просмотраs.rst Paste:

modules/models.rst

Внутри ваших/доксов папки Run:

make html

Тест документации

Вы можете проверить вашу документацию, запустив этот код в папке/докудах:

make linkcheck

Воила! Вы сделали!

Это мой первый публичный учебник, так что дайте мне несколько хлопьев, если вам это нравится:)

Спасибо за чтение! Посмотрите больше статей, как это на моем профиле FreeCodeCamp: https://www.freecodeCamp.org/news/author/goran/ и другие забавные вещи, которые я строит на моей странице GitHub: https://github.com/goranaviani