Sphinx është një mjet i dobishëm i bazuar në Python për teknikët dhe shkrimtarët që u lejon atyre të krijojnë me lehtësi dokumentacion elegant, plotësisht funksional në formate të ndryshme. Me Sphinx, ju shkruani dokumente duke përdorur reStructuredText -- një gjuhë e lehtë shënjimi -- për fillestarët, më pas mund të merrni rezultatin në formate të shumta, duke përfshirë HTML, LaTeX, PDF, ePub dhe të tjerë.
Në këtë tutorial, ne do të mbulojmë procesin e instalimit dhe përdorimit Sphinxnë një shembull CentOS 7 x64 në platformën e 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
Përpara se të filloni të përdorni Sphinx, duhet të specifikoni direktorinë tuaj burimore në të cilën Sphinxdo të ekzekutohet dhe do të ruhet i gjithë dokumentacioni juaj. Pasi të keni krijuar direktorinë që keni ndërmend të përdorni, më pas mund të ekzekutoni e sphinx-quickstartcila do të inicializojë Sphinxdhe krijojë konfigurimin bazë të kërkuar.
sphinx-quickstart është i ngjashëm me një magjistar konfigurimi i cili do t'ju nxisë me pyetje që përcaktojnë aspektet e projektit tuaj.
cd ~
mkdir doc1
cd doc1
sphinx-quickstart
Si parazgjedhje, sphinx-quickstartmagjistari do të krijojë disa drejtori dhe skedarë.
_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
Le t'i hedhim një sy skedarit master, index.rst, i cili përmban hierarkinë e dokumentacionit tuaj; domethënë, pema e tabelës së përmbajtjes ose toctree.
Hapeni atë me një redaktues teksti:
vi index.rst
Ndërsa rishikoni skedarin, do të vini re një seksion të quajtur toctree. Nëse keni skedarë të tjerë burimor ( *.rst) për dokumentacionin tuaj, do t'ju duhet t'i specifikoni në toctreeseksionin: .. toctree:: :maxdepth: 2
introduction
chapter1
chapter2
chapter3
more
Është e domosdoshme që:
.rst.:maxdepth: 2.Pasi të keni përfunduar modifikimet tuaja, ruani skedarin tuaj dhe dilni nga redaktori i tekstit.
ESC
:!wq
Skedarët burim duhet të krijohen me emra që përputhen me atë që ishte specifikuar më parë në index.rst, përndryshe ato nuk do të përfshihen në daljen përfundimtare.
Të gjithë skedarët burim duhet të jenë të pajtueshëm me reStructuredText markup language. Për më shumë informacion, ju lutemi referojuni reStructuredText Primer .
Pasi të keni mbaruar përpilimin e dokumentacionit tuaj, mund të nxirrni punën tuaj HTML format duke ekzekutuar komandën e mëposhtme:
make html
Dalja do të ruhet në drejtorinë e ./\_build/htmlcila përfshin gjithçka të nevojshme për shikimin e skedarit në një shfletim në internet.
Kjo përfundon tutorialin tonë.
Përdorimi i një sistemi të ndryshëm? Plesk është një panel kontrolli i pronarit të hostit në internet që lejon përdoruesit të administrojnë faqet e tyre të internetit personale dhe/ose të klientëve, bazat e të dhënave
Squid është një program i popullarizuar, falas Linux që ju lejon të krijoni një përfaqësues në ueb përcjellës. Në këtë udhëzues, do të shihni se si të instaloni Squid në CentOS për t'ju kthyer
Hyrje Lighttpd është një fork i Apache që synon të jetë shumë më pak intensiv me burime. Është i lehtë, prandaj emri i tij, dhe është mjaft i thjeshtë për t'u përdorur. Instaloni
VULTR kohët e fundit ka bërë ndryshime në fund të tyre dhe gjithçka duhet të funksionojë mirë tani me NetworkManager të aktivizuar. Nëse dëshironi të çaktivizoni
Icinga2 është një sistem i fuqishëm monitorimi dhe kur përdoret në një model master-klient, ai mund të zëvendësojë nevojën për kontrolle monitorimi të bazuara në NRPE. Master-klien
Përdorimi i një sistemi të ndryshëm? Apache Cassandra është një sistem i menaxhimit të bazës së të dhënave NoSQL falas dhe me burim të hapur që është krijuar për të ofruar shkallëzim, të lartë
Përdorimi i një sistemi të ndryshëm? Microweber është një CMS me burim të hapur drag and drop dhe dyqan online. Kodi burimor Microweber është pritur në GitHub. Ky udhëzues do t'ju tregojë
Përdorimi i një sistemi të ndryshëm? Mattermost është një alternativë me burim të hapur, të vetë-strehuar për shërbimin e mesazheve Slack SAAS. Me fjalë të tjera, me Mattermost, ju rreth
Paneli i kontrollit Plesk përmban një integrim shumë të bukur për Lets Encrypt. Lets Encrypt është një nga ofruesit e vetëm SSL që jep plotësisht certifikata
Lets Encrypt është një autoritet certifikimi i dedikuar për të ofruar certifikata SSL pa pagesë. cPanel ka ndërtuar një integrim të pastër në mënyrë që ju dhe klienti juaj
Përdorimi i një sistemi të ndryshëm? Concrete5 është një CMS me burim të hapur që ofron shumë veçori dalluese dhe të dobishme për të ndihmuar redaktorët në prodhimin e përmbajtjes me lehtësi dhe
Using a Different System? Review Board is a free and open source tool for reviewing source code, documentation, images and many more. It is web-based softwar
Në këtë udhëzues, do të mësoni se si të konfiguroni vërtetimin HTTP për një server ueb Nginx që funksionon në CentOS 7. Kërkesat Për të filluar, do t'ju duhet
YOURLS (Shkurtësi juaj i URL-së) është një aplikacion për shkurtimin e URL-ve me burim të hapur dhe analitikë të të dhënave. Në këtë artikull, ne do të mbulojmë procesin e instalimit
Përdorimi i një sistemi të ndryshëm? Hyrje ArangoDB është një bazë të dhënash NoSQL me burim të hapur me një model fleksibël të dhënash për dokumente, grafikë dhe vlera-kyçe. Eshte
Hyrje Drejtoria /etc/ luan një rol kritik në mënyrën se si funksionon një sistem Linux. Arsyeja për këtë është sepse pothuajse çdo konfigurim i sistemit
Shumë administratorë të sistemit menaxhojnë sasi të mëdha serverash. Kur skedarët duhet të aksesohen nëpër serverë të ndryshëm, hyni në secilin individualisht rreth
Ky tutorial do të mbulojë procesin e instalimit të një serveri lojërash Half Life 2 në Sistemin CentOS 6. Hapi 1: Instalimi i parakushteve Për të vendosur ou
Laravel GitScrum, ose GitScrum është një mjet produktiviteti me burim të hapur i krijuar për të ndihmuar ekipet e zhvillimit të zbatojnë metodologjinë Scrum në një mënyrë të ngjashme.
Hyrje Në këtë tutorial të Vultr, do të mësoni se si të instaloni PowerDNS. PowerDNS është një program për ekzekutimin e serverëve tuaj të emrave. Është shumë e dobishme kur
Inteligjenca Artificiale nuk është në të ardhmen, është këtu në të tashmen Në këtë blog Lexoni se si aplikacionet e inteligjencës artificiale kanë ndikuar në sektorë të ndryshëm.
A jeni edhe ju viktimë e Sulmeve DDOS dhe jeni konfuz në lidhje me metodat e parandalimit? Lexoni këtë artikull për të zgjidhur pyetjet tuaja.
Ju mund të keni dëgjuar se hakerët fitojnë shumë para, por a keni menduar ndonjëherë se si i fitojnë ato para? Le te diskutojme.
Dëshironi të shihni shpikjet revolucionare nga Google dhe se si këto shpikje ndryshuan jetën e çdo njeriu sot? Më pas lexoni në blog për të parë shpikjet nga Google.
Koncepti i makinave vetë-drejtuese për të dalë në rrugë me ndihmën e inteligjencës artificiale është një ëndërr që e kemi prej kohësh. Por, pavarësisht nga disa premtime, ato nuk shihen askund. Lexoni këtë blog për të mësuar më shumë…
Ndërsa Shkenca evoluon me një ritëm të shpejtë, duke marrë përsipër shumë nga përpjekjet tona, rriten edhe rreziqet për t'iu nënshtruar një Singulariteti të pashpjegueshëm. Lexoni, çfarë mund të thotë singulariteti për ne.
Metodat e ruajtjes së të dhënave kanë evoluar mund të jenë që nga lindja e të dhënave. Ky blog mbulon evolucionin e ruajtjes së të dhënave në bazë të një infografike.
Lexoni blogun për të njohur shtresat e ndryshme në arkitekturën e të dhënave të mëdha dhe funksionalitetet e tyre në mënyrën më të thjeshtë.
Në këtë botë të drejtuar nga dixhitali, pajisjet inteligjente të shtëpisë janë bërë një pjesë thelbësore e jetës. Këtu janë disa përfitime të mahnitshme të pajisjeve shtëpiake inteligjente se si ato e bëjnë jetën tonë të vlefshme dhe më të thjeshtë.
Së fundmi Apple lëshoi macOS Catalina 10.15.4 një përditësim shtesë për të rregulluar problemet, por duket se përditësimi po shkakton më shumë probleme që çojnë në bricking të makinerive mac. Lexoni këtë artikull për të mësuar më shumë
