Vad ska jag läsa härnäst?¶
Så du har läst allt introduktionsmaterial och har bestämt dig för att du vill fortsätta använda Django. Vi har bara skrapat på ytan med den här introduktionen (om du har läst vartenda ord har du faktiskt läst ungefär 5% of av den totala dokumentationen).
Så vad händer nu?
Vi har alltid varit stora fans av att lära oss genom att göra. Vid det här laget bör du veta tillräckligt för att starta ett eget projekt och börja roa dig. När du behöver lära dig nya knep, kom tillbaka till dokumentationen. Det finns också ett större Django ekosystem där ute för dig att utforska som samhället har skapat.
Vi har lagt ner mycket arbete på att göra Djangos dokumentation användbar, tydlig och så komplett som möjligt. Resten av detta dokument förklarar mer om hur dokumentationen fungerar så att du kan få ut det mesta av den.
(Ja, det här är dokumentation om dokumentation. Var så säker på att vi inte har några planer på att skriva ett dokument om hur man läser dokumentet om dokumentation)
Hitta dokumentation¶
Django har mycket dokumentation - nästan 450 000 ord och mer därtill - så det kan ibland vara svårt att hitta det man behöver. Ett bra ställe att börja på är Index. Vi rekommenderar också att du använder den inbyggda sökfunktionen.
Eller så kan du bara surfa runt!
Hur dokumentationen är organiserad¶
Djangos huvuddokumentation är uppdelad i ”chunks” som är utformade för att fylla olika behov:
Introduktionsmaterialet är utformat för personer som är nya i Django - eller i webbutveckling i allmänhet. Det går inte på djupet, utan ger istället en översikt på hög nivå över hur det ”känns” att utveckla i Django.
topic guides, å andra sidan, dyker djupt in i enskilda delar av Django. Det finns kompletta guider till Djangos modellsystem, template engine, forms framework, och mycket mer.
Det är förmodligen här du kommer att vilja spendera mest tid; om du arbetar dig igenom dessa guider bör du veta i stort sett allt som finns att veta om Django.
Webbutveckling är ofta bred, inte djup - problem spänner över många domäner. Vi har skrivit en uppsättning :doc:``how-to guides </howto/index>` som svarar på vanliga ”Hur gör jag …?”-frågor. Här hittar du information om generera PDF-filer med Django, skriva anpassade malltaggar, och mer.
Svar på riktigt vanliga frågor finns också i FAQ.
Guiderna och instruktionsböckerna täcker inte varje enskild klass, funktion och metod som finns i Django - det skulle vara överväldigande när du försöker lära dig. Istället finns detaljer om enskilda klasser, funktioner, metoder och moduler i referens. Det är hit du vänder dig för att hitta detaljerna för en viss funktion eller vad du än behöver.
Om du är intresserad av att distribuera ett projekt för allmän användning finns det i våra dokument flera guider för olika distributionsupplägg samt en checklista för distribution för några saker du behöver tänka på.
Slutligen finns det en del ”specialiserad” dokumentation som vanligtvis inte är relevant för de flesta utvecklare. Detta inkluderar release notes och internals documentation för dem som vill lägga till kod till Django själv, och en få andra saker som inte passar någon annanstans.
Hur dokumentationen uppdateras¶
Precis som Djangos kodbas utvecklas och förbättras på daglig basis, förbättras vår dokumentation ständigt. Vi förbättrar dokumentationen av flera skäl:
Att göra innehållskorrigeringar, till exempel grammatik- och typsnittskorrigeringar.
Att lägga till information och/eller exempel i befintliga avsnitt som behöver utökas.
Att dokumentera Django-funktioner som ännu inte är dokumenterade. (Listan över sådana funktioner krymper men finns ändå)
Att lägga till dokumentation för nya funktioner när nya funktioner läggs till, eller när Django API:er eller beteenden ändras.
Djangos dokumentation förvaras i samma källkontrollsystem som dess kod. Den finns i katalogen docs i vårt Git-arkiv. Varje dokument online är en separat textfil i förvaret.
Var du kan få tag på den¶
Du kan läsa Django-dokumentationen på flera sätt. De är, i den ordning de föredras:
På webben¶
Den senaste versionen av Django-dokumentationen finns på https://docs.djangoproject.com/en/dev/. Dessa HTML-sidor genereras automatiskt från textfilerna i källkontrollen. Det betyder att de återspeglar det ”senaste och bästa” i Django - de innehåller de allra senaste korrigeringarna och tilläggen, och de diskuterar de senaste Django-egenskaperna, som kanske bara är tillgängliga för användare av Djangos utvecklingsversion. (Se :ref:skillnader-mellan-dok-versioner nedan)
Vi uppmuntrar dig att hjälpa till att förbättra dokumentationen genom att skicka in ändringar, korrigeringar och förslag i ticketsystemet. Django-utvecklarna övervakar aktivt biljettsystemet och använder din feedback för att förbättra dokumentationen för alla.
Observera dock att ärendena uttryckligen bör relatera till dokumentationen, snarare än att ställa breda frågor om teknisk support. Om du behöver hjälp med din specifika Django-installation, prova Django Forum eller Django Discord server istället.
I klartext¶
För offline-läsning, eller bara för enkelhetens skull, kan du läsa Django-dokumentationen i klartext.
Om du använder en officiell version av Django innehåller det zippade paketet (tarball) med koden en docs/-katalog, som innehåller all dokumentation för den versionen.
Om du använder utvecklingsversionen av Django (även kallad huvudgrenen) innehåller katalogen docs/ all dokumentation. Du kan uppdatera din Git-utcheckning för att få de senaste ändringarna.
Ett lågteknologiskt sätt att dra nytta av textdokumentationen är att använda Unix-verktyget grep för att söka efter en fras i all dokumentation. Till exempel kommer detta att visa dig varje omnämnande av frasen ”max_length” i alla Django-dokument:
$ grep -r max_length /path/to/django/docs/
...\> grep -r max_length \path\to\django\docs\
Som HTML, lokalt¶
Du kan få en lokal kopia av HTML-dokumentationen genom att följa några steg:
Djangos dokumentation använder ett system som heter Sphinx för att konvertera från vanlig text till HTML. Du måste installera Sphinx genom att antingen ladda ner och installera paketet från Sphinx webbplats eller med
pip:$ python -m pip install Sphinx
...\> py -m pip install SphinxAnvänd sedan den medföljande
Makefileför att omvandla dokumentationen till HTML:$ cd path/to/django/docs $ make html
Du behöver ha GNU Make installerat för detta.
Om du använder Windows kan du alternativt använda den medföljande batchfilen:
cd path\to\django\docs make.bat htmlHTML-dokumentationen kommer att placeras i
docs/_build/html.
Skillnader mellan olika versioner¶
Textdokumentationen i huvudgrenen i Git-arkivet innehåller de ”senaste och bästa” ändringarna och tilläggen. Dessa ändringar inkluderar dokumentation av nya funktioner som är inriktade på Djangos nästa feature release. Av den anledningen är det värt att påpeka vår policy att lyfta fram de senaste ändringarna och tilläggen till Django.
Vi följer denna policy:
Utvecklingsdokumentationen på https://docs.djangoproject.com/en/dev/ kommer från huvudgrenen. Dessa dokument motsvarar den senaste funktionsutgåvan, plus alla funktioner som har lagts till/ändrats i ramverket sedan dess.
När vi lägger till funktioner i Djangos utvecklingsversion uppdaterar vi dokumentationen i samma Git commit-transaktion.
För att särskilja funktionsändringar/tillägg i dokumenten använder vi frasen: ”Nytt i Django Development version” för den version av Django som inte har släppts ännu, eller ”Nytt i version X.Y” för släppta versioner.
Dokumentationsfixar och förbättringar kan backporteras till den senaste utgivningsgrenen, enligt sammanslagningen, men när en version av Django är stödjs inte längre, kommer den versionen av dokumentationen inte att få några ytterligare uppdateringar.
Webbsidan Huvuddokumentation innehåller länkar till dokumentation för tidigare versioner. Se till att du använder den version av dokumentationen som motsvarar den version av Django som du använder!
