sphinxcontrib-bibtex är en Sphinx förlängning som gör bibtex referenser som skall införas i din dokumentation. & Nbsp; Förlängningen lägger ett direktiv bibliografi och en citera roll, som fungerar på liknande sätt LaTeX s bibliografi och cite kommandon.
författare: Matthias C. M. Troffaes.
Inspirerad av bibstuff.sphinxext.bibref av Matthew Brett.
Installation
Installera modulen med pip installera sphinxcontrib-bibtex, eller från källan med hjälp python setup.py installera. Lägg sedan till:
extensions = ['sphinxcontrib.bibtex']
till ditt projekt Sphinx konfigurationsfil conf.py.
Minimal Exempel
I ditt projekt dokumentation, kan du sedan skriva till exempel:
Se: cite: `1987: nelson` för en introduktion till icke-standardanalys.
.. Bibliografi :: refs.bib
där refs.bib skulle innehålla en post:
Book {1987: nelson,
& Nbsp; author = {Edward Nelson},
& Nbsp; title = {Radikalt Elementary Sannolikhetsteori},
& Nbsp; utgivare = {Princeton University Press},
& Nbsp; år = {1977},
& Nbsp; serien = {Annals of Mathematical Studies}
}
Krav :
- Python
- Sphinx
Kommentarer hittades inte