Įrašai
Nauji mokymai skirti jūsų „Sphinx“ pradedantiesiems, norintiems išmokti projektų kūrimo pagrindus ir kaip juos tvarkyti. Taip pat galite atsisiųsti savo „Git“ saugyklos paveikslėlį tar.gz arba zip formatu. Naudodami „Docker“ paveikslėlius, mėgaukitės „Docker“ darbais pagal poreikį, kad galėtumėte iškviesti „Sphinx“ komandas.
Nuorodos į atsisiunčiamus dokumentus¶ | Immerion casino programos atsisiuntimo naujinys
„Free“ priesaga visiems tipiniams duomenų failams. „Free pickle creator“ yra puikus jos poklasis. Turite nurodyti, kurie failai bus rasti kuriose gairėse, kurias naudotojai turėtų naudoti „theman_profiles“ nustatymuose.
Pilnų API įrašų kūrimas¶
Kad konstruktorius naudojamas derinti naują „Sphinx“ / „Docutils“ kanalą „Peržiūros priemonė, padedanti transformuoti į autorių“. Kiekvienam aukščiausio lygio dokumentui ar pakatalogiui sukuriama atskira .container katalogo tema. Dizaineris sukuria „gettext-build“ pranešimų katalogus.
Patikrinkite visų išorinių nuorodų vientisumą. Sukurkite gairių profilius „groff“ formatu, kad galėtumėte valdyti UNIX sistemas. Šis vaidmuo puikiai tinka funkcijai „standard_character“. Kai kurių planų atveju galite pakeisti „any“ į konkretų vaidmenį. Jei vartojate žodį, kurio nepaminėta žodynėlyje, generavimo metu matysite gerą įspėjimą. Ryšys su reikiamu failu; naujas failo pavadinimas bus šeimos narys arba tiesioginis kelias, o tai gali būti skausminga ir jautri net ir ekranui.
Atkreipkite dėmesį, kad „rinohtype“ teikia tiesioginę PDF kūrimo priemonę. Norint sukurti tinkamą pagalbos vadovą, jai reikalingas komandinės eilutės įrankis „hiutil“, kuris pasiekiamas tik „Mac“ kompiuteriuose su „OS X 10.6“ ir naujesnėmis versijomis. Šio tipo aplankai buvo praleisti kituose dokumentacijos modeliuose.
Naujausio kūrėjo palaikomų MIME tipo vizualizavimo formų meniu. Vizualizuoti failus iš tikrųjų rodomas Immerion casino programos atsisiuntimo naujinys ten, kur jie rodomi. Jei norite sukurti nuorodas, kad galėtumėte įtraukti duomenis iš savo dokumentacijos, galite tai padaryti naudodami sphinx.ext.intersphinx. Rašant Python kodą, įprasta įdėti daug dokumentų į šaltinio dokumentus, dokumentų eilutėse. Nesvarbu, kuris dokumentas gauna tikrus dokumentus forenumerate(); Sphinx juos gaus ir sukurs su jais ryšį. Šis žymėjimas sukurs ryšį su naujausiais enumerate() dokumentais.
Kryžminės nuorodos į kitus įdomius dalykus¶
Pavyzdžiui, norint dokumentuoti „Python“ įdiegtą funkciją enumerate(), reikėtų ją įtraukti į vieną šaltinio dokumento dalį. Pavyzdžiui, peržiūrėdami naujausią HTML adaptaciją, galite išbandyti naują šaltinio kodą – šoninėje juostoje naudokite nuorodą „Pasakykite kilmę“. Kiekvienas gali sukurti duomenų failus, kuriuos nurodėte naujame toctree, ir sukurti straipsnius, o jų skyrių pavadinimai bus įrašyti (pagal naują maxdepth lygį) toje vietoje, kur įdėta toctree direktyva. Pridėtini failai pateikiami kaip failų žymės, o tai reiškia, kad atsijungiate nuo failo plėtinio ir bandote naudoti įstrižuosius brūkšnius (/) kaip katalogų skirtukus. Tai yra vienas iš pagrindinių dalykų, kuriuos „Sphinx“ prisideda prie „reStructuredText“ – metodo, skirto sujungti kelis duomenis į vieną žingsnį iš dokumentų.
Anksčiau teigiau, kad naujas conf.py dokumentas kontroliuoja, kaip „Sphinx“ apdoroja jūsų įrašus. Kiekvienam domeno vardui tikrai bus taikomos unikalios taisyklės, kaip atrodys nauji parašai, ir kad naujai suformatuotas efektyvumo tyrimas būtų gražus, kitaip į C/C++ domenų vardus įtraukite tam tikras nuostatas, pvz., nuorodas į parametrų tipus, age.grams. Jūsų direktyvos naujas konfliktas yra aprašomo tikslo prekės ženklas, o pranešimas yra dėl jo esantys dokumentai.
Kuris kūrėjas teikia identišką produkciją kaip ir atskiras HTML kūrėjas, bet taip pat kuria Qt pagalbos rinkinio pagalbos failus, kurie leidžia naujam Qt rinkinio kūrėjui rinkti jį. Šis kūrimo įrankis siūlo panašų kūrinį kaip ir atskiras HTML kūrėjas, bet taip pat kuria HTML pagalbos failus, kurie leidžia naudoti naujausią „Microsoft HTML HelpWorkshop“, kad galėtumėte rinkti jį viename CHM faile. Tai HTML kūrimo įrankis, kuris sujungia visą jūsų darbą į išvesties failą. (Žinoma, jis dirba tik su trumpesniais projektais.) Naujausias failas vadinamas šakniniu failu.
Daug daugiau dizainerių bus papildomų plėtinių. Tai yra priklausomi „Sphinx“ dizaineriai. Patogumo dalis bando valdyti savo darbą, kad rastų tinkamą teisėtą adresą savo nuorodos tekstiniam pranešimui. Jis nebūtinai turi būti tame pačiame faile kaip ir terminų žymėjimas, pavyzdžiui, „Python“ dokumentuose yra vienas pasaulinis žodynėlis faile glossary.rst. Žodynėlis sudaromas naudojant žodynėlio direktyvą, kurioje yra klasifikacijų sąrašas su žodžiais ir apibrėžimais. Tai sukuria nuorodą į pasirinkimo direktyvą, jei tokia yra.
Kad galėtumėte žaisti su „intersphinx“, turite juos aktyvuoti faile conf.py, įterpdami naujausią eilutę „sphinx.ext.intersphinx“ į savo plėtinių sąrašą ir įvesdami konfigūracijos vertę „intersphinx_mapping“. Naujausias failas automatiškai išsaugomas UTF-8 formatu, kaip nurodyta kodavimo deklaracijoje pirmoje eilutėje. Atminkite, kad naujas failas naudoja Python sintaksę grandinėje, kiekyje, kataloguose ir kt. Norėdami tinkinti konfigūracijos vertę, kurios automatiškai neprideda „sphinx-quickstart“, tiesiog pridėkite papildomą užduotį. Naujausias Python domeno vardas taip pat yra standartinis domeno vardas, todėl jums nereikia pridėti naujos žymėjimo versijos prie savo svetainės pavadinimo. „ReStructuredText“, kad galėtumėte išplėsti savo svetainės pavadinimą ir naudoti „reStructuredText“ bei žymėjimą iš „Sphinx“.