Awtomatikong pangkat ng edad ng mga file na malayo sa code

Ang pinakabagong halimbawa ay naglalayong maging handa ang iyong mga baguhan sa Sphinx na matutunan ang mga pangunahing kaalaman kung paano binubuo ang mga ideya at kung paano ka maaayos. Maaari ka ring kumuha ng snapshot ng iyong sariling Git repo sa loob ng posibleng tar.gz o zip structure. Gamit ang mga imahe ng docker, maaari kang mag-activate ng docker work on demand upang magamit ang mga utos ng sphinx.

Pagtukoy sa mga nada-download na data file¶

Ang bagong hulapi para sa lahat ng regular na dokumento. Ang bagong pickle builder ay isang mahusay na subclass nito. Kailangan mong tukuyin kung aling mga file ang dapat gamitin kung aling mga tip ang gagabay sa mga pahina sa pamamagitan ng theman_users na solusyon.

Paglikha ng mga komprehensibong sanggunian sa API¶

Aling creator ang maaaring gamitin upang i-debug ang bagong pipe na "Audience to help you Transform to Author" ng Sphinx/Docutils. Para sa bawat dokumento o subdirectory na mas mataas ang kalidad, nagpapataas ito ng indibidwal na tema ng koleksyon na .pot. Ang creator na ito ay gumagawa ng mga katalogo ng mensahe na gettext-layout.

Basahin ang katatagan ng lahat ng panlabas na link. Gumawa ng mga manu-manong user sa loob ng groff style para sa mga UNIX system. Aling karakter ang isang magandang aplikante para sa setting na default_character. Sa kaso ng maraming target, maaari mong baguhin ang "any" sa isang partikular na karakter. Kapag gumamit ka ng terminong hindi mo nabanggit sa isang glossary, bibigyan ka ng magandang babala habang gumagawa. Relasyon sa tinukoy na dokumento; ang pinakabagong pagkakakilanlan ng dokumento ay maaaring miyembro ng pamilya kung hindi man ay absolutepath at palaging case-sensitive, pati na rin sa iyong Windows.

Tandaan na ang pangunahing tagalikha ng PDF ay ibinibigay ng rinohtype.

Para matulungan kang gumawa ng isang lehitimong gabay sa pag-install, aling tagalikha ang nangangailangan ng commandline unit na hiutil, na limitado sa iyong Mac OS X 10.6 pataas. Ang mga folder na ito ay maaaring balewalain mula sa iba pang mga uri ng dokumento.

Ang menu ng MIME ay parang mga platform ng larawan na sinusuportahan ng bagong tagabuo. Ang mga dokumento ng larawan ay hinahanap mula sa acquisition kung saan lumalabas ang mga ito dito. Kung gusto mong gumawa ng mga hyperlink para sa mga halimbawa ng mga file mula sa iyong dokumentasyon, maaari itong gawin gamit ang sphinx.ext.intersphinx. Kapag nagdodokumento ng Python code, karaniwan na maglagay ng maraming papeles sa mga source file, sa loob ng files chain. Hindi ito nagno-numero at kinukuha ng file ang mga totoong file para sa enumerate(); nahahanap sila ng Sphinx at bumuo ng kaugnayan dito. Ang markup na ito ay maaaring magtatag ng kaugnayan sa mga bagong file mula sa enumerate().

Pagtutugma ng ibang mga bagay na kawili-wili¶

Kaya, para idokumento ang Python na nakabatay sa function na enumerate(), idadagdag mo ito sa 1 mula sa iyong source data. Halimbawa, kapag gumagamit ka ng bagong HTML form, maaari mong tingnan ang bagong source para sa file na iyon – gamitin ang link na “Tell You Source” mula sa sidebar. Maaari mo na ngayong likhain ang data na inilagay mo sa bagong toctree at maaari kang magdagdag ng mga blog, at ang kanilang mga pamagat ng seksyon ay idadagdag (sa bagong maxdepth level) mula sa lugar kung saan nakalagay ang toctree directive. Ang mga file na isasama ay makukuha bilang mga label ng file, na nangangahulugang maaari kang umalis sa extension ng file term at gumamit ng mga forward slash(/) mula sa mga list separator. Isa ito sa mga bahagi ng mga bagay na itinataguyod ng Sphinx sa reStructuredText, isang paraan para ikonekta ang maraming data sa isang hierarchy ang layo mula sa mga file.

Bago ko nabanggit na ang bagong dokumentong conf.py ay nagreregula kung paano pinoproseso ng Sphinx ang iyong mga post. Ang bawat domain ay magkakaroon ng mga espesyal na batas at regulasyon para sa kung paano maaaring lumitaw ang mga pinakabagong lagda, at gagawing mas maayos ang hitsura ng pinakabagong naka-format na output, o magsasama ng mga partikular na tampok kabilang ang mga link sa mga bersyon ng parameter, halimbawa sa mga C/C++ domain. Ang bagong dispute ng direktiba ay ang lagda ng target na iyong inilalarawan, ang nilalaman ay ang mga papeles para dito.

Aling tagalikha ang nagbibigay ng parehong kahusayan tulad ng nag-iisang tagalikha ng HTML, ngunit lumilikha rin ng mga file ng data ng serbisyo ng koleksyon ng tulong ng Qt na nagbibigay-daan sa pinakabagong tagalikha ng koleksyon ng Qt na tulungan kang tipunin ang mga ito. Nag-aalok ang tagabuo nito ng katulad na produksyon tulad ng nag-iisang tagalikha ng HTML, ngunit lumilikha rin ng mga dokumento ng suporta ng HTML Let na nagbibigay-daan sa pinakabagong Microsoft HTML HelpWorkshop upang tipunin ang mga ito sa isang mahusay na dokumento ng CHM. Ito ay isang tagabuo ng HTML na pinagsasama ang buong proyekto sa loob ng dokumento ng isa hanggang sa produksyon. (Siyempre na gumagana lamang sa mas maiikling proyekto.) Ang bagong dokumento ay tinatawag na dokumento ng mapagkukunan.

Mas maraming builder ang magiging karagdagang extension. Ang mga ito ay nakabatay sa mga developer ng Sphinx. Ang benepisyo nito sa karakter ay sumusubok na lumikha ng mas mahusay na makita ang isang mahusay na target upang magkaroon ng tekstong sanggunian nito. Sa pangkalahatan, hindi ito kailangang nasa parehong file gaya ng kahulugan ng markup, halimbawa, ang mga dokumento ng Python ay may isang pandaigdigang glossary sa glossary.rstfile. Ang isang glossary ay ginagawa gamit ang direktiba ng glossary na naglalaman ng listahan ng kahulugan na may mga kondisyon at kahulugan. Na bumubuo ng isang link sa isang direktiba ng pagpipilian, kung maaari itong makuha.

Para matulungan kang galugarin ang intersphinx, kailangan mong i-trigger ang mga ito sa loob ng conf.py sa pamamagitan ng paglalagay ng pinakabagong sequence na 'sphinx.ext.intersphinx' para sa listahan ng mga extension at ilagay ang halaga ng config na `intersphinx_mapping`. Ang pinakabagong file ay awtomatikong iniimbak sa loob ng UTF-8, gaya ng ipinapadala ng deklarasyon ng encoding sa unang hanay. Tandaan lamang na ang pinakabagong dokumento ay gumagamit ng istruktura ng pangungusap na Python para sa chain, number, listahan at iba pa. Para i-customize ang halaga ng config na hindi awtomatikong idinaragdag ng `sphinx-quickstart`, magdagdag lamang ng karagdagang assignment. Ang bagong domain ng Python ay ang karaniwang domain, kaya hindi mo kailangang i-prefix ang bagong markup sa pangalan ng domain. `ReStructuredText` para sa mas malawak na karagdagan sa `reStructuredText` at `markup` para sa Sphinx.