de væsentlige sfinks - cheatsheet for hurtigere dokumentation

,,,,,,, i sidste uge, i skriver dokumentation, når produktionen flere formater med sfinks, vi lærte at installere sfinksen dokumentation generator, og til at opbygge: pdf, epub og andre dokumenter fra en ny sfinks anlæg.i dag skal vi skabe en lille test projekt med nogle originale indhold, og mærk den ved hjælp af rullende materiel, de indfødte sfinks markup language.så du kan bygge flere output formater fra din kilde.alt du behøver er din favorit tekst redaktør og en sfinks anlæg.,, f.eks. projekt for denne artikel, er enkelt og viser, at det væsentlige.start med at downloade det vigtigste eksempel side, f.eks. i første række, skærmbillede af afsmeltet html side, sphinx html side. men heller ikke dér er menneskene sikre, og det andet projekt filer fra google køre., example.rst, er en sfinks kilde fil, og sphinx-html-page.png, viser, hvad det ligner, efter at gøre: kommando.,, fornuft tips, når du har brug for hjælp, skal altid henvise til sfinksen referencehåndbog, snarere end at spilde tid på web - søgninger, fuld af forkerte svar.,, sfinks er skrevet i slange, så whitespace spørgsmål.løb ofte bygger, da dette er den hurtigste måde at finde - fejl.dette eksempel fra at gøre html, finder en fejl, og fortæller os, hvor det er:,, book1 $gøre html [...] /home /carla /book1 /indhold og f.eks. første: 23: advarsel: afsnit understrege, for kort.første niveau subhead =================, dokumentation, struktur, i f.eks. projekt for denne artikel, projektet filstruktur ser sådan ud:,, book1



Previous:
Next Page: