Sphinx este un instrument util bazat pe Python pentru tehnicieni și scriitori care le permite să creeze cu ușurință documentație elegantă, complet funcțională, în diferite formate. Cu Sphinx, scrieți documente folosind reStructuredText - un limbaj de marcare ușor - pentru început, apoi puteți obține ieșirea în mai multe formate, inclusiv HTML, LaTeX, PDF, ePub și altele.
În acest tutorial, vom acoperi procesul de instalare și utilizare Sphinxpe o instanță CentOS 7 x64 pe platforma Vult.
sudo yum update
sudo shutdown -r now
sudo yum install -y python-devel python-setuptools python-pip
sudo pip install --upgrade pip
sudo pip install -U Sphinx
Înainte de a începe utilizarea Sphinx, trebuie să specificați directorul sursă în care Sphinxva rula și să salvați toată documentația. După ce ați creat directorul pe care intenționați să-l utilizați, puteți rula apoi sphinx-quickstartcare va inițializa Sphinxși crea configurația de bază necesară.
sphinx-quickstart este similar cu un vrăjitor de configurare care vă va solicita întrebări care determină aspectele proiectului.
cd ~
mkdir doc1
cd doc1
sphinx-quickstart
În mod implicit, sphinx-quickstartexpertul va crea mai multe directoare și fișiere.
_build # The directory for containing Sphinx output
conf.py # The file containing your project configurations
index.rst # The master file containing the hierarchy of your documentation
make.bat # A Windows command file
Makefile # A file necessary for running the make command
_static # The directory for static files, including custom stylesheets, pictures, etc.
_templates # The directory for custom templates
Să aruncăm o privire asupra fișierului principal index.rst, care conține ierarhia documentației dvs.; și anume, arborele de conținut sau toctree.
Deschide-l cu un editor de text:
vi index.rst
Când analizați fișierul, veți observa o secțiune apelată toctree. Dacă aveți alte fișiere sursă ( *.rst) pentru documentația dvs., va trebui să le specificați în toctreesecțiunea: .. toctree ::: maxdepth: 2
introduction
chapter1
chapter2
chapter3
more
Este obligatoriu să:
.rst.:maxdepth: 2.După ce ați finalizat modificările, salvați fișierul și ieșiți din editorul de text.
ESC
:!wq
Fișierele sursă trebuie create cu nume care se potrivesc cu cele specificate anterior index.rst, în caz contrar nu vor fi incluse în ieșirea finală.
Toate fișierele sursă trebuie să fie compatibile cu reStructuredText markup language. Pentru mai multe informații, consultați reStructuredText Primer .
După ce ați terminat să vă redactați documentația, puteți să vă efectuați lucrările HTML format executând comanda de mai jos:
make html
Ieșirea va fi salvată în directorul ./\_build/htmlcare include tot ceea ce este necesar pentru vizualizarea fișierului într-o navigare web.
Acest lucru încheie tutorialul nostru.
Introducere RethinkDB este o bază de date NoSQL care stochează date sub formă de documente JSON. Are un limbaj de interogare super intuitiv și are funcții disponibile în mod obișnuit
În anumite ocazii, este posibil ca un administrator de sistem să aibă nevoie să creeze un cont de utilizator și să restricționeze accesul acestora la gestionarea propriilor fișiere prin sFTP, dar nu b
Folosind un sistem diferit? NGINX poate fi utilizat ca server HTTP / HTTPS, server proxy invers, server proxy de poștă, echilibrator de sarcină, terminator TLS sau cachin
Folosind un sistem diferit? Chamilo este un sistem gratuit și deschis de management al învățării (LMS), care este utilizat pe scară largă pentru educația online și colaborarea în echipă
Odoo, cunoscută anterior drept OpenERP, este o cunoscută platformă de afaceri ERP open source. Întreprinderile de orice dimensiune pot beneficia de Odoo, datorită licenței sale abundente
Folosind un sistem diferit? Couch CMS este un sistem de gestionare a conținutului (CMS) simplu și flexibil, gratuit și deschis, care permite proiectanților web să deseneze
Folosind un sistem diferit? SonarQube este un instrument open source pentru dezvoltarea sistemului de calitate. Este scris în Java și acceptă mai multe baze de date. Oferă
NextCloud, așa cum sugerează și numele său, este o alternativă promițătoare a unei alte soluții de hosting de fișiere open source OwnCloud. În acest articol, vă voi arăta
Folosind un sistem diferit? Netdata este o stea în creștere în domeniul monitorizării în timp real a metricilor sistemului. Comparativ cu alte instrumente de același fel, Netdata:
Folosind un sistem diferit? În acest tutorial, voi explica cum să configurați un server Starbound pe CentOS 7. Condiții preliminare Trebuie să dețineți acest joc pe dvs.
Bine ați venit la un alt tutorial Vultr. Aici, veți învăța cum să instalați și să rulați un server SAMP. Acest ghid a fost scris pentru CentOS 6. Condiții preliminare pe care le veți obține
Folosind un sistem diferit? Elgg este un motor de rețea socială open source care permite crearea de medii sociale, cum ar fi rețelele sociale din campus
RStudio Server este ediția web a RStudio care este o serie de instrumente concepute pentru a facilita munca de codare folosind limbajul de programare R. În ti
Bolt este un CMS open source scris în PHP. Codul sursă Bolts este găzduit pe GitHub. Acest ghid vă va arăta cum instalați Bolt CMS pe un nou CentOS 7 Vult
Bugzilla este un sistem gratuit și open source de urmărire a erorilor, care este utilizat pe scară largă de diverși furnizori pentru a-și îmbunătăți continuu softwar-ul
Prezentare generală Acest articol este menit să vă ajute să obțineți un cluster Kubernetes și să funcționeze cu kubeadm în cel mai scurt timp. Acest ghid va implementa două servere, pe
Folosind un sistem diferit? Introducere Sails.js este un cadru MVC pentru Node.js, similar cu Ruby on Rails. Face pentru dezvoltarea aplicațiilor moderne ver
Funcțiile Vultrs Adu-ți spațiul IP permite o libertate fără precedent în alocarea propriilor resurse IP serverelor din norul Vultr. Noi generall
Acest tutorial va acoperi procesul de instalare a unui server de joc Half Life 2 pe CentOS 6 System. Pasul 1: Instalarea condițiilor preliminare Pentru a configura ou
Introducere Sistemele Linux sunt livrate cu instrumente de monitorizare în mod implicit, cum ar fi top, df și du care ajută la monitorizarea proceselor și a spațiului pe disc. De multe ori însă, acestea sunt
O perspectivă asupra a 26 de tehnici de analiză a datelor mari: partea 1
Mulți dintre voi cunoașteți Switch care va fi lansat în martie 2017 și noile sale funcții. Pentru cei care nu știu, am pregătit o listă de funcții care fac din „Switch” un „gadget obligatoriu”.
Aștepți ca giganții tehnologiei să-și îndeplinească promisiunile? vezi ce a ramas nelivrat.
Citiți blogul pentru a cunoaște diferitele straturi din Arhitectura Big Data și funcționalitățile acestora în cel mai simplu mod.
Citiți asta pentru a afla cum devine populară inteligența artificială în rândul companiilor la scară mică și cum crește probabilitățile de a le face să crească și de a le oferi concurenților avantaje.
CAPTCHA a devenit destul de dificil de rezolvat pentru utilizatori în ultimii ani. Va fi capabil să rămână eficient în detectarea spam-ului și a botului în viitor?
Pe măsură ce Știința Evoluează într-un ritm rapid, preluând multe dintre eforturile noastre, crește și riscurile de a ne supune unei Singularități inexplicabile. Citiți, ce ar putea însemna singularitatea pentru noi.
Ce este telemedicina, îngrijirea medicală la distanță și impactul acesteia asupra generației viitoare? Este un loc bun sau nu în situația de pandemie? Citiți blogul pentru a găsi o vedere!
Poate ați auzit că hackerii câștigă mulți bani, dar v-ați întrebat vreodată cum câștigă acești bani? sa discutam.
Recent, Apple a lansat macOS Catalina 10.15.4 o actualizare suplimentară pentru a remedia problemele, dar se pare că actualizarea provoacă mai multe probleme care duc la blocarea mașinilor Mac. Citiți acest articol pentru a afla mai multe
