Nilalaman
Pahina ng buod na ginawa ng autosummary¶ At muli, kapag pinatakbo ang generate html, ang pinakabagong pagganap ay maaaring katulad ng dati. Sa nakaraang seksyon ng tutorial, manu-mano mong naitala ang isang mahusay na Python mode sa loob ng Sphinx. Gayunpaman, ang conf.py ay maaari ding mabuhay sa isa pang listahan, ang pinakabagong direktoryo ng pag-setup. Sphinx.ext.intersphinx para sa buong malfunction ng iyong mga tampok ng intersphinx.
Booi pagpaparehistro sa pag-login – Pagpapagana ng bagong-bagong konstruksyon¶
Ang Toctree ay isang mahusay na direktiba ng reStructuredText, isang napaka-flexible na piraso ng markup. Pagkatapos mo rito, maaari mong bisitahin ang publikasyon ng pag-install na may bagong intro upang matulungan ka sa default na format ng markup na ginagamit ng Sphinx, ang reStructuredText. Iba pang mga wika ang katutubong sinusuportahan sa loob ng Sphinx para sa dokumentasyon ng code, ngunit kailangan nila ng mga extension para sa awtomatikong dokumentasyon ng code, tulad ng Breathe. Upang ipakita ang mga kakayahan ng Sphinx na magkaroon ng mga code file, gagamitin mo ang Python, na tumutulong din sa awtomatikong pag-grupo ng mga file. Mamamahala ka ng isang mahusay na koleksyon ng kathang-isip na software upang makabuo ng hindi regular na pattern ng pagkain na magsisilbing isang mahusay na gabay sa buong proseso, upang ligtas itong maitala. Ang iyong mga panel ay dapat magsama ng naratibo, sulat-kamay na mga dokumento, at mga awtomatikong nabuo na API file.
Pagtutugma ng iba pang mga bagay na interesante¶
Hanapin ang impormasyon ng Serialization creator para sa impormasyon tungkol sa bagong format ng output. Gumagawa ang tagalikha ng isang bahagi para i-execute ang bagong Python serialization API (pickle, simplejson, phpserialize, at ilan pa) para matanggal ang mga nabuong HTML file. Dapat mong tukuyin kung aling data ang gagamitin sa mga Texinfo file sa pamamagitan ng texinfo_documentsconfiguration value. Gumagawa ang tagalikha ng mga Texinfo file na maaaring i-convert sa Data file ng makeinfo program. Nagbibigay ang tagalikha ng parehong performance bilang stand-alone na HTML builder, ngunit lumilikha rin ng mga aktibong subscriber ng epub list.
Para sa bawat direktiba, itinatatag kung mayroon itong mga pagtutol, at kung gaano ito karami. Ang mga argumento ay iniaalok nang personal pagkatapos ng dobleng anus na kasunod ng label ng direktiba. Ang pangunahing layunin sa likod ng root file ay ang magsilbing isang mahusay na webpage ng pagtanggap, at upang ma-secure ang root ng "desk out of articles tree" (o toctree). Ang layunin ng soit file ay ang bigyan ka ng isang simpleng kagustuhan na malayo sa kung ano talaga ang mga Sphinx at kung paano mo magagamit ang mga ito.
Ang domain name ay ilang uri ng bagay na nabibilang sa kanya, kasama ang markup para Booi pagpaparehistro sa pag-login makatulong sa paggawa at pagtukoy ng mga paglalarawan ng mga bagay. Pinapatakbo ng Make Latex PDF ang bagong Latex builder at madali mong maipapakilala ang bagong pdfTeXtoolchain sa iyo. Ngunit hindi, ang sphinx-quickstart program ay lumilikha ng isang mahusay na Makefile at maaari kang gumawa ng amake.bat na ginagawang mas madali ang buhay para sa iyo.
Bubuo ito ng mga HTML docs sa listahan ng create na iyong pinili. Maaari itong maisagawa sa pamamagitan ng pagpapatakbo ng make sa pagkakakilanlan ng creator. (Maaari silang magsama ng mga toctree directive nang mag-isa, para makagawa ka ng mga seryosong nested hierarchy kung kinakailangan.)
Unang setting¶
Ang bawat direktiba ay nagpapasya kung papayagan itong maging mga blog o hindi, at mayroon kang magagawa sa loob. Itinatala ng mga blog ang iyong mga opsyon o pagtutol pagkatapos ng isang blangkong linya. Ang "maxdepth" ay isang opsyon sa direktiba ng toctree.
Kaya kasama rin sa direktoryo nito ang bagong Sphinxconfiguration file na conf.py, kung saan maaari mong i-configure ang lahat ng aspeto palayo sa kung paano binabasa ng Sphinx ang kanilang source at bubuo ka ng iyong mga papeles. Gayunpaman, kinokopya nila ang pinakabagong reStructuredText source files sa pinakabagong _source directory sa ilalim ng output list. Kaya nagbibigay ang builder nito ng text file para sa bawat reStructuredText file. Halos katulad ito ng bagong reStructuredText resource, ngunit karamihan sa mga pinakabagong markup ay tinanggal para sa mas madaling basahin. Hanapin ang latex_data at ang seksyong Mga Opsyon para sa Latex output para sa mga available na opsyon.
Aling tagalikha ang gumagawa ng katulad na produksiyon bilang standalone na tagalikha ng HTML, ngunit bumubuo rin ng dokumentong sumusuporta sa GNOME Devhelp na nagbibigay-daan sa bagong GNOME Devhelp reader na tingnan ang mga ito. Kabilang dito, ang bagong documentmarkup/rest.rst ay hindi nagdudulot ng markup/other people.html productivity file, ngunit ang markup/rest/list.html. Ang kahusayan nito ay isang mahusay na direktoryo na may mga HTML data file, kung saan ang bawat dokumento ay tinatawag na list.html at ililista ka sa isang subdirectory na pinangalanan ang pagkakakilanlan ng kanilang pahina. Ang "pangalan" ng pinakabagong tagalikha ay dapat ibigay sa mga bagong opsyon sa command-line na -M o -b ng sphinx-create upang pumili ng isang tagabuo.