sfinksi on työkalu, jonka avulla on helppo luoda älykkäitä ja kauniita asiakirjat Python hankkeisiin (tai muut asiakirjat, jotka koostuvat useista reStructuredText lähteet), kirjoittanut Georg Brandl. Projekti on alun perin luotu kääntää uuden Python asiakirjoja, mutta on nyt siivottu siinä toivossa, että se olisi hyödyllinen moniin muihin hankkeisiin.
Sfinksi käyttää reStructuredText sen markup language, ja monet sen vahvuudet tulevat voima ja selkeys sekä reStructuredText ja sen jäsentämiseen ja kääntäminen sviitti, Docutils.
Vaikka se on edelleen jatkuvan kehityksen alla, seuraavat ominaisuudet ovat jo läsnä, toimivat hyvin ja voidaan nähdä "in action" Python docs:
& Nbsp; * Tuetut tiedostomuodot: HTML (mukaan lukien Windows HTML Help) ja LaTeX, painettavan PDF versiot
& Nbsp; * Laaja rajat viittaukset: semanttisen markup ja automaattiset linkkejä toimintojen luokat, Sanastoa ja vastaavat paloja tiedot
& Nbsp; * hierarkkisen: helppo määritelmä dokumenttipuussa, automaattisella linkkejä sisarukset, vanhemmat ja lapset
& Nbsp; * Automaattinen indeksit: yleisindeksi sekä moduuli indeksi
& Nbsp; * Koodi käsittely: automaattinen korostus käyttäen Pygments korostustyökalu
& Nbsp; * eri laajennukset ovat käytettävissä, esim. automaattiseen testaukseen katkelmia ja osallisuuden asianmukaisesti alustettu docstrings.
Vaatimukset :
- Python
Kommentteja ei löytynyt