Ito ang command na sphinx-build na maaaring patakbuhin sa OnWorks na libreng hosting provider gamit ang isa sa aming maramihang libreng online na workstation gaya ng Ubuntu Online, Fedora Online, Windows online emulator o MAC OS online emulator
PROGRAMA:
NAME
sphinx-build - tool ng generator ng dokumentasyon ng Sphinx
SINOPSIS
sphinx-build [pagpipilian]sourcedir>labas> [mga filename ...]
DESCRIPTION
sphinx-build bumubuo ng dokumentasyon mula sa mga file sa at ilagay ito sa
.
sphinx-build hinahanap para sa /conf.py para sa mga setting ng pagsasaayos.
sphinx-mabilis na pagsisimula(1) ay maaaring gamitin upang bumuo ng mga template file, kabilang ang conf.py.
sphinx-build maaaring lumikha ng dokumentasyon sa iba't ibang mga format. Pinipili ang isang format ng
pagtukoy ng pangalan ng tagabuo sa command line; ito ay default sa HTML. Maaari din ang mga tagabuo
magsagawa ng iba pang mga gawain na nauugnay sa pagproseso ng dokumentasyon.
Bilang default, ang lahat ng hindi napapanahon ay binuo. Output lamang para sa mga napiling file ay maaaring
binuo sa pamamagitan ng pagtukoy ng mga indibidwal na filename.
Listahan ng mga magagamit na tagabuo:
html Pagbuo ng HTML file. Ito ang default na tagabuo.
dirhtml
Pagbuo ng HTML file sa bawat HTML file na pinangalanang "index.html" sa isang hiwalay
direktoryo.
singlehtml
Pagbuo ng HTML file kasama ang lahat ng nilalaman sa isang HTML file.
htmltulong
Bumubuo ng mga file para sa pagbuo ng CHM (compiled help files).
qthelp Bumubuo ng mga file para sa pagbuo ng koleksyon ng tulong ng Qt.
devhelp
Bumubuo ng mga file para sa GNOME Devhelp help viewer.
LaTeX Bumubuo ng LaTeX output na maaaring i-compile sa isang PDF na dokumento.
lalaki Bumubuo ng mga manu-manong pahina.
texinfo
Bumubuo ng output ng Texinfo na maaaring iproseso ng makeinfo upang makabuo ng isang Impormasyon
dokumento.
EPUB Bumubuo ng ePub e-book na bersyon ng HTML na output.
teksto Bumubuo ng isang plain-text na bersyon ng dokumentasyon.
gettext
Bumubuo ng mga katalogo ng Gettext message para sa pagsasalin ng nilalaman.
mga pagbabago
Bumubuo ng mga HTML file na naglilista ng binago/idinagdag/hindi na ginagamit na mga item para sa kasalukuyang bersyon
ng dokumentadong proyekto.
linkcheck
Sinusuri ang integridad ng lahat ng panlabas na link sa pinagmulan.
atsara / json
Bumubuo ng mga serialized na HTML file para magamit sa mga web application.
xml Bumubuo ng Docutils-katutubong XML file.
pseudoxml
Bumubuo ng mga compact na medyo naka-print na "pseudo-XML" na mga file na nagpapakita ng panloob
istraktura ng mga intermediate na puno ng dokumento.
Opsyon
-b
Tagabuo na gagamitin; default sa html. Tingnan ang buong listahan ng mga tagabuo sa itaas.
-a Bumuo ng output para sa lahat ng mga file; kung wala ang pagpipiliang ito ay output lamang para sa bago at binago
nabuo ang mga file.
-E Huwag pansinin ang mga naka-cache na file, pinipilit na muling basahin ang lahat ng source file mula sa disk.
-d
Path sa mga naka-cache na file; default sa /.doctrees.
-j Bumuo nang kahanay sa mga proseso ng N kung saan posible.
-c
Hanapin ang conf.py file sa tinukoy na landas sa halip na .
-C Tukuyin na walang conf.py file ang gagamitin. Maaari lamang itakda ang configuration
gamit ang -D na opsyon.
-D
I-override ang isang setting mula sa configuration file.
-t
Tukuyin mga tag para gamitin sa "lamang" na mga bloke.
-A
Magpasa ng halaga sa mga template ng HTML (para lang sa mga tagabuo ng HTML).
-n Tumakbo sa nit-picky mode, magbabala tungkol sa lahat ng nawawalang reference.
-v Dagdagan ang verbosity (maaaring ulitin).
-N Pigilan ang may kulay na output.
-q Tahimik na operasyon, mag-print lamang ng mga babala at error sa stderr.
-Q Napakatahimik na operasyon, huwag mag-print ng anuman maliban sa mga error.
-w
Sumulat ng mga babala at error sa ibinigay na file, bilang karagdagan sa stderr.
-W Gawing mga error ang mga babala.
-T Ipakita ang buong traceback sa exception.
-P Patakbuhin ang Pdb sa exception.
Gumamit ng sphinx-build online gamit ang mga serbisyo ng onworks.net