repoze.sphinx.autointerface määrittelee laajennus sfinksi dokumentointijärjestelmä. & Nbsp; laajentaminen mahdollistaa sukupolven API-dokumentaation mukaan itsetutkiskelun zope.interface tapauksia koodin.
Asennus:
Asenna kautta easy_install:
bin / easy_install repoze.sphinx.autointerface
tai jollakin muulla saa paketin teidän PYTHONPATH.
rekisteröiminen Extension
Lisää repoze.sphinx.autointerface ja laajennuksia luettelossa conf.py sfinksin dokumentaatiosta tuotteen. Esim .:
laajennukset = ['sphinx.ext.autodoc',
& Nbsp; "sphinx.ext.doctest",
& Nbsp; "repoze.sphinx.autointerface",
& Nbsp;]
käyttäminen Extension
Tarkoituksenmukaisiin paikkoihin dokumentissa, huutavat käyttöliittymä autodocs kautta:
.. Autointerface :: yourpackage.interfaces.IFoo
Ulostulo direktiiviin sisältyy
& Nbsp; * täysin pätevä käyttöliittymä nimi
& Nbsp; * mitään pohja rajapinnat
& Nbsp; * doctstring käyttöliittymän, kääntää myös reSTX.
& Nbsp; * jäsenet käyttöliittymä (menetelmät ja attribuutteja).
& Nbsp; o kunkin ominaisuuden, tuotantoon kuuluu attribuutin nimi ja sen kuvaus.
& Nbsp; o Kullekin menetelmälle, tuotantoon kuuluu menetelmän nimi, sen allekirjoittamisesta, ja sen docstring (myös kääntää myös reSTX).
Mitä uutta tässä julkaisussa:
- PyPy yhteensopivuus.
- Python 3.2+ yhteensopivuus. Kiitos Arfrever varten laastari.
- Sisällytä käyttöliittymä docs alle automodule direktiivin. Kiitos Krys Lawrence laastari.
Mitä uutta versiossa 0.6.2:
- Fix Tyyppivirhe: "NoneType" kohde ei ole iterable virhe luotaessa renderöinti käyttöliittymä alle Python 2.7.
Mitä uutta versiossa 0.6.1:
- Fix ': jäsen kertaluvun: bysource "käsittely .
Mitä uutta versiossa 0.6:
- oikein käsitellä ": Jäseniä:" arvoja nimenomaisesti asetettu direktiiviä.
Mitä uutta versiossa 0.5:
- Lisätty tuki ": jäsen kertaluvun:" lippu , joka voi olla jokin kolmesta varastossa arvoja, & quot; aakkosellinen & quot ;, & quot; GroupWise & quot ;, tai & quot; bysource & quot ;. Oletuksena jäsenet dokumentoitu & quot; hash & quot; järjestys.
Vaatimukset :
- Python
- sfinksi
Kommentteja ei löytynyt