,,,,, at sfinksen pyton dokumentation blev oprindeligt skabt til at bygge python generator dokumentation, og så udviklede det sig til en god almen dokumentation skaber.det er især velegnet til at skabe tekniske dokumentation til støtte for billeder, krydshenvisninger, automatisk indekser, fleksible indholdsfortegnelse, henvisninger og fodnoter.fra en enkelt kilde fil du kan skabe en enkelt eller flere side http: //pdf, epub, json, latex, texinfo mand sider, og almindelig tekst dokumenter.,, sfinks er indfødt markup language er restructuredtext (rullende materiel), og parsing og oversættelse, håndteres af docutils.den første er let at lære, og dokumenteres fuldt ud.når du bygge - og se din produktion sider, sphinx automatisk finder markup fejl for dig.,, at installere sfinks, på de fleste linux udlodninger sfinksen pakke er python sfinks.dette skal installere en række områder, såsom pyton, docutils, pygments, latex, og forskellige udvidelser,.,, sfinksen har mange udvidelser, og en god mulighed for at forvalte dem, som ikke er afhængige af distro emballage bruger, pip, pip installationer - pakker) pytonen pakke forvaltningssystem, at installere pakker direkte fra pypi, den pyton pakke indeks.pytonen pakke indeks er den officielle pyton pakke register.på de fleste linux distros, pip, kommer i, pyton pip - pakken.installere sphinx på denne måde, pip, pip, $sudo installere sfinks, første opsætning, sphinx omfatter et manuskript, sphinx hurtigt skal iværksættes, til at iværksætte deres nye projekt og skabe sit oprindelige konfiguration.det anmoder dem om en række spørgsmål, som f.eks. projektets navn, forfatter og adresseregister struktur og lagrer dine svar på, conf.py, fil.skabe og indlede en ny fortegnelse for dit projekt, og så løb de manuskript:,, $mkdir book1 $cd book1 $sfinks hurtigt skal iværksættes velkommen til sfinksen 1.3.1 hurtigt skal iværksættes utility.,, det beder du en række spørgsmål.svar ja til alt. det gør ikke noget, og sikrer, at de har fuld funktionalitet, og du kan altid få ændringer senere.når du er færdig, det ser sådan ud:,, skabe fil. /kilde /conf.py.oprettelse af sagsakter. /kilde /index.rst.oprettelse af sagsakter. /makefile.oprettelse af sagsakter. /make.bat.færdig: en første fortegnelse over struktur har skabt.,, din adresseregister indhold bør se sådan ud:,, book1 $er bygge make.bat makefile kilde, gå og lave nogle bygge ordrer til at se, hvad der sker, så at oprette websteder: http: //,,, book1 $gøre: det skaber en at bygge, fortegnelse, kommer til at finde og se dit nye html side.figur 1 (ovenfor) viser resultatet.,, løb, får hjælp til at se alle dine bygge mål, eller se på dit projekt er makefile:,, book1 $få hjælp brug "," hvor er en af html til enkeltstående html filer dirhtml til html filer, der hedder i telefonbøger. singlehtml til et enkelt stort html fil - at gøre pickles filer json at gøre json filer htmlhelp til html filer og en html hjælpe projekt qthelp til html filer og en qthelp projekt applehelp at gøre et æble hjælpe bog devhelp til html filer og en devhelp projekt, epub at foretage en epub latex for latex - filer, - du kan sætte papir = a4 eller papir = brev [...],,,, sphinx ikke inc.mangler du noget seere for deres produktion af filer, så du bliver nødt til at finde din egen.f.eks. åbne html filer med webbrowser, epub filer med en epub læser, og læs mand sider med manden kommando:,, book1 $mand bygge /mand /thefoomanual. 1, og se, din nye mand side (figur 2).,,,,, naturligvis eksempel er tomt, fordi vi har ikke skabt nogen indhold endnu.,, løb, gør rent, før der en anden bygge, for at sikre, at du starter med en tom bygge fortegnelse.,, sphinx afhængig af latex, og du vil sikkert se fejlmeddelelser om forsvundne udvidelser, når man bygger dokumenter, f.eks. mangler, pdflatex, når du prøver at bygge en pdf - fil:,, book1 $gøre latexpdf sfinks bygge - b latex - d bygge /doctrees kilde bygge /latex løber sfinks v1.3.1. gør produktionen telefonliste.[...] [1]: pdflatex: befaler ikke gør [1]: * * * [thefoomanual. pdf] fejl 127 gøre [1]: forlader adresseregister er /home /carla /book1 /bygge /latex ": * * * [2] fejl latexpdf, er det også fælles om en ny sfinks anlæg for at se fejlmeddelelser om forsvundne,. sti, filer.den sikreste måde at helbrede disse fejl til at installere, texlive, pakker, som du kan få på debian med metapackage, texlive fuldt ud.dette omfatter sprog, videnskab og matematik udvidelser, så det er ca. 1,5 gigabytes, og installationer til 3gb.installation af følgende (debian /ubuntu /pebermynte) vil give dig alt, hvad du har brug for, uden at det er nødvendigt at installere det hele:,,, texlive,, texlive base, texlive ekstra utils,, texlive skrifttype utils,, texlive skrifttyper anbefalede, texlive latex ekstra, texlive latex anbefalede, basen, texlive pakken er på centos er ret omfattende, og centos giver et stort antal mindre texlive pakker, så du kan installere, hvad du vil, uden at det er nødvendigt at installere en kæmpe klump af det hele.hat giver tre bjørne meta - emballage ordning, texlive ordning fuldt ud, texlive ordning medium, og texlive ordning grundlæggende, og som centos, et stort antal små pakker.,, du kan undgå distro emballage drama ved hjælp af tex leve til at installere og forvalte deres tex pakker direkte fra kilden. med projektet muligheder,,, conf.py, journal på dit projekt root adresseregister kontrollerer alle jeres projekt er muligheder, og det er den fil at redigere at ændre nogen muligheder, du valgte, da du løb, sphinx hurtigt skal iværksættes.for eksempel, hvis du svarede ja til "indeholde links til kildekoden for dokumenteret pyton genstande", så hver gang, du køre en bygge dig vente på "- intersphinx opgørelse fra https: //docs. python. org /genstande. inv....".slå dette ved at indtaste din, conf.py, og at de, sphinx.ext.intersphinx, udvidelse af de "generelle konfiguration".,, tilbringe noget tid at blive bekendt med, conf.py, og det er let at ændre de værdier og opbygge deres projekt for at se, hvilke ændringer se ud.det her er hvor du skal finde deres navn, version, ophavsret, udvidelser, og produktionen muligheder for forskellige formater.,, hjemmeside temaer, sphinx, kommer med en række indbyggede temaer:,,, grundlæggende, alabast,, sphinx_rtd_theme, klassisk,, sphinxdoc skriftruller,,,, agogo,,,, pyramide, haiku, traditionelle, epub bizstyle,,,,, og du kan se, hvad nogen af disse ud ved at indtaste temaet navn i "muligheder for html produktion" afdeling, conf.py, og derefter løber, html,:,, html_theme = "pyramide", og den indbyggede disse temaer er muligheder, som du kan få, conf.py, og disse er dokumenteret i sfinks er http: //theming støtte side.for skik temaer gør det ikke, for det er vejen til vanvid, for det vil gøre dit, conf.py, rodet og besværligt.det er bedre at sætte din brugerdefinerede tema i sin egen fortegnelse, og så ind i den relative adresseregister vej (i forhold til deres projekt er grundlæggende directory), conf.py:,, html_theme_path = ['.. /custom_theme ", nu hvor du ved, hvordan at installere sfinks og lave din egen skaber, kom tilbage næste uge for at lære at skabe og format, deres indhold.