A Sphinx egy hasznos Python-alapú eszköz technikusok és írók számára, amely lehetővé teszi számukra, hogy könnyen készítsenek elegáns, teljesen működőképes dokumentációt különféle formátumokban. A Sphinx segítségével először a reStructuredText – egy könnyű jelölőnyelv – használatával írhat dokumentumokat, majd több formátumban is megkaphatja a kimenetet, beleértve a HTML-t, a LaTeX-et, a PDF-t, az ePub-ot és másokat.
Ebben az oktatóanyagban bemutatjuk Sphinxa CentOS 7 x64 példányok telepítésének és használatának folyamatát a Vult platformján.
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
A használat megkezdése előtt Sphinxmeg kell adnia a forráskönyvtárat, amelyben Sphinxfutni fog, és el kell mentenie az összes dokumentációt. Miután létrehozta a használni kívánt könyvtárat, futtassa, sphinx-quickstartamely inicializálja Sphinxés létrehozza a szükséges alapkonfigurációt.
sphinx-quickstart hasonló egy telepítővarázslóhoz, amely olyan kérdéseket tesz fel, amelyek meghatározzák a projekt szempontjait.
cd ~
mkdir doc1
cd doc1
sphinx-quickstart
Alapértelmezés szerint a sphinx-quickstartvarázsló több könyvtárat és fájlt hoz létre.
_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
Vessünk egy pillantást a főfájlra index.rst, amely a dokumentáció hierarchiáját tartalmazza; mégpedig a tartalomjegyzék fa ill toctree.
Nyissa meg egy szövegszerkesztővel:
vi index.rst
A fájl áttekintése során észrevesz egy szakaszt, melynek neve toctree. Ha van más forrásfájlja ( *.rst) a dokumentációjához, akkor ezeket meg kell adnia a következő toctreerészben: .. toctree:: :maxdepth: 2
introduction
chapter1
chapter2
chapter3
more
Feltétlenül szükséges:
.rst.:maxdepth: 2.Miután befejezte a módosításokat, mentse el a fájlt, és lépjen ki a szövegszerkesztőből.
ESC
:!wq
A forrásfájlokat olyan nevekkel kell létrehozni, amelyek megegyeznek a korábban megadottakkal index.rst, különben nem kerülnek be a végső kimenetbe.
Minden forrásfájlnak kompatibilisnek kell lennie a reStructuredText markup language. További információkért tekintse meg a reStructuredText Primert .
Miután befejezte a dokumentáció összeállítását, HTML format az alábbi parancs végrehajtásával kiadhatja a munkáját :
make html
A kimenet egy könyvtárba kerül elmentésre, ./\_build/htmlamely mindent tartalmaz, ami a fájl webböngészés közbeni megtekintéséhez szükséges.
Ezzel az oktatóanyagunk véget is ér.
Más rendszert használ? A Plesk egy szabadalmaztatott webtárhely-vezérlőpult, amely lehetővé teszi a felhasználók számára, hogy adminisztrálják személyes és/vagy ügyfeleik webhelyeit, adatbázisait
A Squid egy népszerű, ingyenes Linux-program, amely lehetővé teszi továbbítási webproxy létrehozását. Ebben az útmutatóban megtudhatja, hogyan telepítheti a Squid-et a CentOS rendszerre, hogy megfordítsa
Bevezetés A Lighttpd az Apache forkja, amely sokkal kevésbé erőforrás-igényes. Könnyű, innen kapta a nevét, és meglehetősen egyszerű a használata. Telepítés
A VULTR a közelmúltban változtatásokat hajtott végre a saját oldalukon, és most már mindennek jól kell működnie, ha a NetworkManager engedélyezve van. Ha szeretné letiltani
Az Icinga2 egy hatékony felügyeleti rendszer, és mester-kliens modellben használva helyettesítheti az NRPE-alapú felügyeleti ellenőrzések szükségességét. A mester-kliens
Más rendszert használ? Az Apache Cassandra egy ingyenes és nyílt forráskódú NoSQL adatbázis-kezelő rendszer, amelyet úgy terveztek, hogy biztosítsa a méretezhetőséget,
Más rendszert használ? A Microweber egy nyílt forráskódú drag and drop CMS és online bolt. A Microweber forráskódja a GitHubon található. Ez az útmutató megmutatja neked
Más rendszert használ? A Vanilla forum egy nyílt forráskódú, PHP-ben írt fórumalkalmazás. Ez egy teljesen testreszabható, könnyen használható, és támogatja a külsőt
Más rendszert használ? A Mattermost egy nyílt forráskódú, saját üzemeltetésű alternatívája a Slack SAAS üzenetküldő szolgáltatásnak. Más szóval, a Mattermost segítségével kb
Mire lesz szüksége Egy Vultr VPS legalább 1 GB RAM-mal. SSH hozzáférés (root/adminisztrátori jogosultságokkal). 1. lépés: A BungeeCord telepítése Először is
A Plesk vezérlőpult nagyon szép integrációt kínál a Lets Encrypt számára. A Lets Encrypt egyike az egyetlen SSL-szolgáltatónak, amely teljes tanúsítványt ad ki
A Lets Encrypt egy tanúsító hatóság, amely ingyenes SSL-tanúsítványokat biztosít. A cPanel ügyes integrációt épített ki, így Ön és ügyfele
Más rendszert használ? A Concrete5 egy nyílt forráskódú CMS, amely számos megkülönböztető és hasznos funkciót kínál, hogy segítse a szerkesztőket a tartalom egyszerű létrehozásában.
Más rendszert használ? A Review Board egy ingyenes és nyílt forráskódú eszköz a forráskód, a dokumentáció, a képek és még sok más áttekintésére. Ez egy web alapú szoftver
Ebből az útmutatóból megtudhatja, hogyan állíthat be HTTP-hitelesítést egy CentOS 7 rendszeren futó Nginx webszerverhez. Követelmények A kezdéshez szüksége lesz a következőre:
Más rendszert használ? A GoAccess egy nyílt forráskódú webnapló-elemző. Használhatja naplók valós idejű elemzésére akár a terminálon, akár a
A YOURLS (Your Own URL Shortener) egy nyílt forráskódú URL-rövidítő és adatelemző alkalmazás. Ebben a cikkben a telepítés folyamatával foglalkozunk
Más rendszert használ? Bevezetés Az ArangoDB egy nyílt forráskódú NoSQL adatbázis, amely rugalmas adatmodellt kínál dokumentumokhoz, grafikonokhoz és kulcsértékekhez. Ez
Bevezetés Az /etc/ könyvtár kritikus szerepet játszik a Linux rendszer működésében. Ennek az az oka, hogy szinte minden rendszerkonfiguráció
Sok rendszergazda nagy mennyiségű kiszolgálót kezel. Ha a fájlokhoz különböző szervereken keresztül kell hozzáférni, mindegyikbe külön-külön kell bejelentkezni kb
A mesterséges intelligencia nem a jövőben, hanem itt a jelenben. Ebben a blogban Olvassa el, hogyan hatott a mesterséges intelligencia alkalmazások különböző ágazatokra.
Ön is DDOS támadások áldozata, és tanácstalan a megelőzési módszereket illetően? Olvassa el ezt a cikket a kérdések megoldásához.
Talán hallottál már arról, hogy a hackerek sok pénzt keresnek, de elgondolkodtál már azon, hogyan kereshetnek ennyi pénzt? beszéljük meg.
Szeretné látni a Google forradalmi találmányait, és azt, hogy ezek a találmányok hogyan változtatták meg minden mai ember életét? Ezután olvassa el a blogot, és nézze meg a Google találmányait.
Az önvezető autók koncepciója, hogy mesterséges intelligencia segítségével kerüljenek az utakra, már egy ideje álmunk. De számos ígéret ellenére sehol sem látszanak. Olvassa el ezt a blogot, hogy többet megtudjon…
Ahogy a tudomány gyors ütemben fejlődik, átveszi erőfeszítéseink nagy részét, megnő annak a kockázata is, hogy alávetjük magunkat egy megmagyarázhatatlan szingularitásnak. Olvassa el, mit jelenthet számunkra a szingularitás.
Az adatok tárolási módjai az Adatok születése óta alakulhatnak. Ez a blog egy infografika alapján mutatja be az adattárolás fejlődését.
Olvassa el a blogot, hogy a legegyszerűbb módon ismerje meg a Big Data Architecture különböző rétegeit és azok funkcióit.
Ebben a digitálisan vezérelt világban az intelligens otthoni eszközök az élet döntő részévé váltak. Íme az intelligens otthoni eszközök néhány elképesztő előnye, hogyan teszik életünket érdemessé és egyszerűbbé.
Az Apple a közelmúltban kiadott egy kiegészítést a macOS Catalina 10.15.4-hez a problémák megoldására, de úgy tűnik, hogy a frissítés több problémát okoz, ami a Mac gépek blokkolásához vezet. További információért olvassa el ezt a cikket
