Am vizitat recent o companie unde am avut o discuție frumoasă cu unul dintre angajații săi. Am vorbit despre tehnologie și programare. Apoi am atins subiectul documentației proiectului. Mai exact cum React o face automat, dar Django nu. Asta m-a făcut să cred că ar trebui să fac o documentație automată pentru proiectele mele Django.

Nu am putut găsi nicio documentație relevantă despre modul în care s-a făcut, așa că mi-a luat puțin mai mult decât am planificat inițial. Nu pentru că a fost greu, ci pentru că am constatat că documentația oficială Sphinx și alte resurse sunt învechite sau obscure.

Așadar, astăzi am făcut un tutorial simplu, dar cuprinzător, care explică cum să faci documentația Django folosind instrumentul de documentare Sphinx din Ubuntu.

Instalați Sphinx

Mai întâi ar trebui să intrați în mediul virtual pentru proiectul dvs. Django.

Instalarea Sphinx este destul de simplă folosind pip3 (pip pentru Python 3):

pip3 install sphinx

Creați un director de documentare

Odată ce ați instalat Sphinx, va trebui să creați folderul rădăcină a documentului. Acest dosar va conține documentația și alte fișiere de care aveți nevoie (imagini, despre pagini și așa mai departe …).

Creați folderul rădăcină al documentului în folderul principal al proiectului și denumiți-l / docs.

Pentru a porni Sphinx, rulați această comandă în folderul / docs:

sphinx-quickstart

Veți avea o mulțime de opțiuni acum. În majoritatea cazurilor, puteți pur și simplu să tastați din nou opțiunea implicită, dar există câteva opțiuni la care trebuie să acordați atenție.

Așa am răspuns:

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.

Conexiune Django

În folderul proiectului, găsiți /docs/conf.py și în interiorul acestuia, undeva în partea de sus a fișierului, găsiți „#import os”. Chiar sub ea, scrieți acest lucru:

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

Acum există două moduri în care puteți proceda:

  1. Poți să folosești sfinx-apidoc pentru a genera documentație complet automată sau
  2. Puteți construi propriile module care vor fi afișate în documentație.

În acest tutorial vă voi arăta cum să o faceți în ambele sensuri.

1. Sfinx-apidoc

Aceasta este metoda mai simplă în care trebuie doar să navigați în folderul / docs și să executați:

sphinx-apidoc -o . ..

Acum trebuie să vă construiți documentația executând comanda:

make html

Navigheaza catre Dosarul_de_proiect / docs / _build / html și deschis index.html. Aceasta este pagina index a documentației dvs.

2. Construirea propriilor module

Acesta este modul ușor mai complicat, dar vă va oferi mult mai multă libertate în organizarea documentației.

Acum veți dori să creați documentație despre vizualizările dvs., modulele etc. Dar mai întâi permiteți-mi să vă arăt un exemplu ușor, doar pentru a înțelege logica acestei părți:

Accesați folderul / docs și creați un folder nou numit „/ modules”. În interiorul acestuia creați un fișier numit all-about-me.rst:

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

În interiorul all-about-me.rst scrieți așa ceva:

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

I’m Goran Aviani, a Django developer.

Acum ați creat ceva de arătat în documentația dvs., dar totuși nu aveți un loc real în care să îl arătați. Reveniți la folderul / docs și deschideți index.rst și purtați mai jos acest cod

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

Adaugă asta:

modules/all-about-me.rst

Faceți-o astfel încât să existe o linie goală între codul superior și linia adăugată:

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

   modules/all-about-me.rst

Acum trebuie să vă construiți documentația. Schimbați locația în folderul care conține Makefile (care este folderul / docs). Apoi rulați în terminal:

make html

Veți găsi documentația dvs. în

Folderul_de_proiect / docs / _build / html și index deschis.html

Puteți face același lucru pentru vizualizările dvs. Django:

În folderul / modules, creați fișierul views.rst.

touch views.rst

În interiorul fișierului views.rst scrieți acest lucru:

Views
======

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

În index.rst, chiar sub modules / all-about-me.rst, adăugați acest lucru:

modules/views.rst

Acum trebuie din nou să vă construiți documentația executând „make html” în folderul / docs:

make html

Ai idee? Mai întâi creați fișierul .rst și apoi îl introduceți în index.rst, astfel încât să poată fi afișat pe pagina index.html.

Puteți face același lucru pentru modelele dvs. Accesați folderul / modules și creați fișierul models.rst.

touch models.rst

Puteți adăuga așa ceva în fișierul dvs. models.rst:

Models
=======

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

În interiorul index.rst chiar sub module / views.rst lipiți:

modules/models.rst

Executați în folderul / docs:

make html

Test de documentare

Puteți testa documentația dvs. executând acest cod în folderul / docs:

make linkcheck

Voilà! Esti gata!

Acesta este primul meu tutorial public, așa că dă-mi câteva clape dacă îți place 🙂

Mulțumesc că ai citit! Consultați mai multe articole de acest fel pe profilul meu Routech: https://www.freecodecamp.org/news/author/goran/ și alte lucruri distractive pe care le construiesc pe pagina mea GitHub: https://github.com/GoranAviani