Merken

Sphinx autodoc: automated API documentation

Zitierlink des Filmsegments
Embed Code

Automatisierte Medienanalyse

Beta
Erkannte Entitäten
Sprachtranskript
thank you 1 and with additional I can make for those of
gate and from my and that's what the rate needed it might have a plan is that detection garlic came and about an idea 3 orbitals what's what's not he's think school maintenance fees and the 2000 there and then always makes you the the group in Japan and that is a member of bias the Committee on I'm looking for the product the
company accompanied with predictions for the these customers using the general that TEM and this security esteemed and other Python related to below my main
presidential electors and those
have I want to take the 2 southern there 2000 that 15 in the bit about that we have that even in this October efficient always and resilient really into to different any since all the look
think of look and this is the main topic of this system what's that is a feature that is automated arguments variation from source called under look you function diffusions and also uses the strength of that such functions before we jump into the main topic because I want to know how many people know all that of thing and how many people writing that of the and do know
and the same as the donor items and you know that don't think how many people know that all or most people know the facts and maybe AT has this take this you
you know this is this is very likely that explains and that the phase is defined by where we using the function that is the leader of the false right he's about about the when you dive have dumps the fall down function and you place link that to show you where you get that thing
confidence question hiring to that it did not have that that in a bit of may harmful people using it in
thanks gate but I think a
humble people does not use ionizing the determined by using those things so and what is the reason you don't know all right then and some of them I don't know what what we are so that I then or and other some basically the for 1 a lot and it's not a big share and for example sometimes the cities are not up to date and even quantum behavior is changed and those obvious and the some of world and so then I explained you know how to write about those things moreover the fish only if have to stay at dog from title so called and said and what is the discovery of that meaning all things this network and
things ought to look these that mostly used for a way to activate the book things FIL before talking about the things I'm into these have been the old 6 and how does it that what these things I
think the Vedic medicine derecha think staircase look as severe out formant from research at its stomata that the the extension and
and the story told a history all always things this man is there around the even order of things the 2007 and I will show an that meant it was written by matrix but it still has to maintain yeah worth trying to attain their as such situations for that he created that takes into 5 and 7 that 6 for by that gives all use handle making many people's up by the water document they and for they fixed
before and after some time before dialog and also on the way to write documents 1 of these company that Pyysalo share the men it was written by native and thus about some Steve General and sometimes we need to combat mock-ups into other formats think think has been used to recount their more March brought forward from the cells and the degree of asymmetry must make the docks and AP 85 can be integrated into the narrative adults an automated doxepin spirit in and the hosting and what to look for an automated dock readings and hosting by the adults no they all
also seem to have been used by the virus and those already displayed by the Library of the frogs down to do yet to be done gametes is the document No. I February feculent undefined or it's an answer to everything if you write a note and non playful library tools also using the of them like shift work it hits the earth must Jackson you banished song and thinks
provides and these extension to support automated API documentation and fixed portable and what summary look this right what to look at the the most important feature of seeks almost an the isolated to the library I using the old look feature they can be
said about but thinks product for this called for example the celebrities and this even bribery we the user interest formula called to express all the features the library name these deep sort for example and this is the structure of the Irish the library has 3 models ABA to to buy handled by and you do by a 2nd the book so that he's faster right program called you give the by the if you
don't have seeks internationally insulation GUI environment and you need to restore the 6 by the by the it is the same recall that a yes of all the other things should be stored in anything by the environment by them but it is also important if you Easter sinks into battle 3 environment 18 is by W. called even eaten by present to an old look needed any exception to embody a python 2 source called by title 3 think must use
the sink you can get your documentation that the by using makes kick-start command inductively we that is invoked have it because project name or also name and the predicted budget that we don't have also asking you may need Christians but you Jerry all you need to do is keep pressing entities know that Franklin and also it is important for the system because an effort if you invoke resembles that of show him but me that of these I was so little emotional and you you get a hot according to make targets for in that make 5 that we we and I knew and my presentation on the side stand on this option this option is introduced seems seeing slum point and high of so become different from the command . 5
so let's make a stem inductive 3 to generate HTML article you can get the right out in undistributed especially it's immediately like these this is an apt example now you
can see that the the
file structure library 5 under the filter so victory but and the 3 build out on that looks data therefore defies and adopted in particular and you will see we have where you choose the by although the by an index left in the system this year old now we
data ABA goes from Europe social called
the and set of 6 although the extension this is called by article by prior EUS thinks gap or what is important at either sort on the 5th line and red right Saturday and for the right these other URI very best to import them from the older and 95 the other speaks extorted do you have the extension next next this further whatever you want to document this is other like
that of all the modules are directed to your call Dr. but the books he valued that he's a part of a deep fold example Ribery 2nd the books is a list of 5 you can see that all the modular you usage in this book what model is 6 did to see that that is provided by portable order look extension to generate arguments with the the Federal the for I can create OK 9 years automotive take to be
important and specify the model and is an expected In this case indeed the book you use more general reader being boarded up and be inspected underwriting 5 EC members
also we expect effects or a member of a more general not or adjust the more don't again we are now or later this in book and make it in writing phone other
than the that all the make similar you can get much generated document from a book by magazine he then all the more dejected fixed you are moderate and the remainder of the functional signature arguments and I don't think how do we do
work although the generated and intermediate or is right thing after intermediate fire is not generate in you our system just created it in 2 only if you want to see
that in the immediate arrest of rights you can use the high whom we really of something like can you think of the core height and we will be for 1 maybe stem command right of the sea although what objective is the president visa and that the created augmented and content but
and rethink it sinks all to look important you according to get stock things if it means that in order that we use executed according to more moderate robot let me introduce about gets to the this
model really numerable already acquired and then book by divide other commander I
skipped studio if there with import from other if you tried to the document we've using to look and data while the functional and caught by Grover once again with the stomach exterior distance audio on the other
hand civil divide parallel
right green broke using it it is about if an item and the constant and over main if 80 famous Python right and I think because of the exit execution about them your fire will not be moved by creation of that particular matter and you shouldn't try to document the you set up of that apply for output stage but getting was and for year but it means using all the note
that if you don't do that thing and it's out of this out the rights necessary information is and how it is that influential all of the argument if you are looking for a defined and you find you say if you find like these memory at you and that you say I all I can understand that type of argument and the mean even reading the In this case you can
use in for fear that the index for describing argument idea that looking and should have a description for each function argument like the the the later part of about a wall the the least index and of course the evil for you to refer that have this additional of if a few there even describing strip of that Europe it's this EPA few
Greece is in and out of the that article is quite nice so you we say all I can understand each maybe and of
course to that devised to function you can easily make gross very different from other addition to that that functions of course but across the different beyond the page so what I
introduce the basics of portable forming suggests a subject is that the text of depend Aviation Daily stations of the implementation and that the Committee by using the depth of African by using doctor
I think of a good ABA have that with the that yes to use the use of the APA by using the called examples if and don't have the code examples you can address that be usage quickly and in that I and the whole that is under such polarized to and the clean area it caught the Brock only a city this looks like inductive a content always the price conducting shell activity that you can copy on the basis of the red lines they arise from by inductors of
them make its image and you can get us see that's highlighted doctest Brok's like the library using can you that can grasp the APA usage quickly and effectively and also users can try out the easy and then point of view
from the library that I call that example even they cross from the implementation and we can expect that a library did above the new update quality you sample when the index and interface is changed by by Jim service the
sorry I don't believe it and if that call them provide as they arose from 108 implementation and they they're above wouldn't mind to eat because they're above have no spare time to be there in 3 in proceed to do this from the course and excrete the expressivity is a bit of ranking procedure for this year that doctors Tibério do detected deviations of the implementation and that the condition do use doctors to be
that you need to other things doctest extension to conflict by actually on other than a sinc sticks doctors right and research on you all or you or maybe to use that doctors to be with bookmaker doctors to command after that and you can
see that that's fine so we'll provides defendant there to and from the expected 1 like except is expected loss of their sperm while hum an extra 1 is there to be implemented saying that the dance from the dumps function and I think it is not implemented provide any rate and by using the book it so deficiencies in the implementation and some recall that either the condition very if you but you are used to test also contains doctests you don't need to do this by aside 5 francs however if you don't arrive value in this theater and make doctors this to prove to be a good press step a
next is the API for automatic carry reads using both someone as as already noted all look these very is high but if you have a lot of functional over all more generous no you need to
pray prepare many distracted at 5 for each module this books useful you not by In this case you should also prepare such will fight for APA and the current more there's if you have an 102 monitors you should prevail over hundred this applies as
you see it each of these 2 misfires have just for eyes you can get them by beating copy and best and modified however I believe that you don't want to repeat that makes believe
yes there data and this user what summary extension to other such a boring set
up the export summary
extensions these Eastern Europe the core of Cold built by a gang and 96 To address thinks fixed or to somebody to use the extension and the right to use and member of for each portable created Victor an underlying 9 to generate this file what you specify review of view or family you can use all summary
dictum in Europe this fire
as feet and December uses old some ideas to on the talk 3 options that property of so it is that the and if the location all the intermediate requires that we have been generated by Alzheimer's and the contents although altered summary object and the filter to look API and current and you do and mortars name if you want to document and thereby and they're summary you really get to 108 at intermediate culturalist fires so if you have 100 images after make
a stem and an command again after make isn't 1 thing when you can get each documented pages that we that forcing probabilistic the drawbridge operation ancillary and or somebody directly you wrote about Genet indicator of content that linking each model states like the that's what is
discovering undocumented APS by by using the Coverage Extension so long
as we have automated that ought to look by using what summary In addition and now you can also find the deviation of a document on the implementation by using the doctor but how do you find a function that is not right be and not liking docstrings at all for such
stations and we can use Coverage Extension to find undocumented functions crisis and the missile 2 years coverage extension
uses it that coverage extension to constant by beginning 9 7 deadline to outdoor sinks fixed colors to use the extension of or
this book and make coverage after that you can get the view that all cognitive measurements that coverage enabled DVD and they quoted in be undiscovered induced such as color stick and the session you coverage stick to have by some books that and that contains and admitted to functions crises on the model as they see how you can get that under into the function then if the underlying fundamental function using How
about and brief together go to always be down there and make coverage common already than 0 and then you can't distinguish them and prevent there's all of this was under undocumented function by the quote in my opinion that it's fair enough because command students for a fatal and the other is where the coverage is the perfect 1 of and how about unfortunate 3 make coverage also possible to generate coverage built examiner for donkey's or some theaters out of particle which all these conclusion of all of this and you can discover the undocumented functions but you can't that information to associate and so the for the
inconvenience and we have waiting for Europe and contribution to so and program
and this may be is there are reasons for not writing the docstring and that was introduced that the I don't know what the questions that right they have this right of description argument and system broke out the next line to over function signature and the 2nd these are just some of docstrings months yes you can use that involve released for arguments states and the you can use doctors approach for a satellite it's not have been if you can
use portal of summary and this and the coverage you to it makes it very sharp I think the seasons of the use by using 6 order look features and and it's like kind of things and use both dogs when I write on
there and I like to introduce some of the gives the
1st 1 is optional what kind of options for water look
and it'll have severity of selecting members he's to documented just beside member if you specify that also that parameter it needs all members be looking at events and secondly the under and and the height members to move it between the time between the book meant memberOf creates it does not have a democracy if you betray that means that parameter all on the augmented members Linda and primates members of some to document private member of and special member of optional to the document does this remember and like graphs that reason double underscore better understand them and the kth mambazo shown through document inherited from this about graphs by default speaks deadlocked Linda he had its members just a random thing that define that that cross really effective seeks a device for the of options 2nd
1 is that addictive is for Web API think
squandering http domain and extension
provide an HTTP domain to generate delivered bedrock of see you can use gets picked and he http called gets victim is used it's the domain also provides other HTTP bth to detective and like http Koran that's or date or of songs and HTTP she that's character is also prepared and provided by it has fixed form there is to the domain extension it's and it's nicer way BPA fast-paced based where organizer maybe a river API index please like these and that's all thanks contrary Institute domain generate new index at the top 6 and documents and the the this driver HTTP needed to do metal index http domain also contains as thinks comparable to http extension subsamples crossed the border and that correlated with application for them up to a document Web API missiles what much carried by using the reflect the fiction the authorities
that document of you can get
translated multiple stories about editing the selected text on the Python code for all that for
that you can use make get the gift concept in its like gets the gift of sight appealed to 5 and like and make gets gift extract taken from fact because the fire and source file Dr. defines the by or to look it means you can translate them into any language means all the lighting of the origin of the sort that this fire on the price of cells 5 the if you are interested it brief such my bike or 8 bucks fission you this year only Fleischer sense do you have
someone was how to deal is a different version of substrate when I when I have a different result compatibility between versions might need to ration might since look like the this story food that 3 and I I can and and that's what we're doing is a very brief because a story and the question you can so how to deal with the different versions of the of the completion so after doctors is composed of every time a new edition then dupont the save it in your uh summarization system or something like this and so I have different compatibility between versions of myself to you so how do you have some a voice deepest to deal with different versions different versions of the conditions some very it at the more extension of system 3 well thank you are there other formats for docstring supporting and to water to you recommend the infidels fields method other for what other formats for docstrings involve use the result was OK I think the legal Nizar under extreme form of it as a researcher keys but has a 6 month . 3 have not boreal excitation that's the article neither lose docstring for then if you want to use that you can use that seeks to build a still not boreal extension you can yeah you so that you can documents ACT the methods within box things our once you do that I am using his swagger and 1 cool thing that it can do is that you can generate clients from its client coat and even interactive website this you coal uh the methods that are you thinking about developing something like that from docstrings because that would be really really cool I will care all and seeks thinks extension and that's called broke the idea is the use and broke their cities have brought video the Eiffel conservative the sequence diagram extension now look if is in a choose the i engage figured that I think there an calendars drive seeking suppose that for all then you want to figure all of against the using the it you you can use secondary alright creative thinking the thing in the city the front applause you 3rd existed year
and a half past 12 and
Softwarewartung
Gruppenkeim
Automatische Handlungsplanung
Orbit <Mathematik>
Biprodukt
Bitrate
Baum <Mathematik>
Computeranimation
Prognoseverfahren
RIS <Medizin, Informationssystem>
Bit
Computersicherheit
Systemaufruf
Computeranimation
TVD-Verfahren
Parametersystem
Diffusor
Quellcode
Physikalisches System
Computeranimation
Funktion <Mathematik>
Zeichenkette
Rechter Winkel
Binder <Informatik>
Dateiformat
Gerade
Phasenumwandlung
Computeranimation
Funktion <Mathematik>
Sichtbarkeitsverfahren
Bit
Verknüpfungsglied
Zustandsdichte
Bereichsschätzung
Gemeinsamer Speicher
Code
Knoten <Statik>
Dateiformat
Computeranimation
Funktion <Mathematik>
Ablöseblase
Vorlesung/Konferenz
Dateiformat
Computeranimation
Matrizenrechnung
Wasserdampftafel
Fächer <Mathematik>
NP-hartes Problem
Ordnung <Mathematik>
Computeranimation
Metropolitan area network
Computervirus
Gemeinsamer Speicher
Zellularer Automat
Computeranimation
Einfache Genauigkeit
Portscanner
Minimalgrad
Zustandsdichte
Standardabweichung
Asymmetrie
Programmbibliothek
Dateiformat
Lesen <Datenverarbeitung>
Verschiebungsoperator
Ganze Abschließung
Biprodukt
Quick-Sort
Computeranimation
Ausdruck <Logik>
Metropolitan area network
Informationsmodellierung
Funktion <Mathematik>
Softwarewerkzeug
Code
Programmbibliothek
Maßerweiterung
Datenstruktur
Optimierung
Chi-Quadrat-Verteilung
Punkt
Ausnahmebehandlung
Quellcode
Physikalisches System
Programmierumgebung
Kombinatorische Gruppentheorie
Gerichteter Graph
Computeranimation
Einfache Genauigkeit
Konfiguration <Informatik>
Code
Benutzerführung
Projektive Ebene
Programmierumgebung
Versionsverwaltung
Generator <Informatik>
Elektronische Publikation
Funktion <Mathematik>
Automatische Indexierung
Rechter Winkel
Programmbibliothek
Indexberechnung
Reelle Zahl
Physikalisches System
Datenstruktur
Elektronische Publikation
Bitrate
Computeranimation
Ganze Abschließung
Zustandsdichte
Rechter Winkel
Statistische Analyse
Elektronischer Datenaustausch
Fünf
Maßerweiterung
Personal Area Network
Ext-Funktor
Gerade
Gerade
Quick-Sort
Computeranimation
Parametersystem
Informationsmodellierung
Dean-Zahl
Konfiguration <Informatik>
Softwarewerkzeug
Mereologie
Systemaufruf
Mailing-Liste
Ordnung <Mathematik>
Maßerweiterung
Mobiles Endgerät
Computeranimation
Quarkmodell
Soundverarbeitung
Parametersystem
Divergente Reihe
Dean-Zahl
Konfiguration <Informatik>
Restklasse
Elektronische Unterschrift
Computeranimation
Funktion <Mathematik>
Objekt <Kategorie>
Konfiguration <Informatik>
Funktion <Mathematik>
Rechter Winkel
Softwarewerkzeug
Indexberechnung
Speicherabzug
Physikalisches System
Objektklasse
Computeranimation
Informationsmodellierung
Code
Abstand
Ordnung <Mathematik>
Teilbarkeit
Computeranimation
Roboter
System F
Rechter Winkel
Baumechanik
Bitrate
Parallele Schnittstelle
Personal Area Network
Teilbarkeit
Computeranimation
Funktion <Mathematik>
Formale Grammatik
Quarkmodell
Parametersystem
Datentyp
Fächer <Mathematik>
Information
Computeranimation
Arithmetisches Mittel
Portscanner
Metropolitan area network
Modallogik
Deskriptive Statistik
ASCII
Rechter Winkel
Automatische Indexierung
Festspeicher
Datentyp
Vorlesung/Konferenz
Information
Chi-Quadrat-Verteilung
Personal Area Network
Informationssystem
Metropolitan area network
Addition
Verschlingung
Stichprobe
Datenerfassung
Information
Chi-Quadrat-Verteilung
Computeranimation
Vorhersagbarkeit
Funktion <Mathematik>
Homepage
Managementinformationssystem
Datentyp
Nabel <Mathematik>
Nabel <Mathematik>
Code
Computeranimation
Portscanner
Metropolitan area network
OISC
Diskrete-Elemente-Methode
Interaktives Fernsehen
Flächeninhalt
ASCII
Code
Arbeitsplatzcomputer
Basisvektor
p-Block
Chi-Quadrat-Verteilung
Gerade
Inklusion <Mathematik>
Schnittstelle
Softwareentwickler
Sichtenkonzept
Punkt
Stichprobe
Implementierung
Ikosaeder
Speicherbereichsnetzwerk
Computeranimation
Portscanner
Dienst <Informatik>
Funktion <Mathematik>
Automatische Indexierung
Code
Stichprobenumfang
Programmbibliothek
MIDI <Musikelektronik>
Große Vereinheitlichung
Bildgebendes Verfahren
Expertensystem
Implementierung
Schnittstelle
Bit
Ganze Abschließung
sinc-Funktion
Versionsverwaltung
Implementierung
Ranking
Algorithmische Programmiersprache
Computeranimation
Arithmetischer Ausdruck
Konditionszahl
Maßerweiterung
Ext-Funktor
Standardabweichung
Informationssystem
Softwaretest
Einfügungsdämpfung
Elektronische Publikation
Konditionszahl
Implementierung
Speicherabzug
Computeranimation
Funktion <Mathematik>
Metropolitan area network
Modul <Datentyp>
Computeranimation
Homepage
Funktion <Mathematik>
Diskrete-Elemente-Methode
Ganze Abschließung
Menge
Singularität <Mathematik>
Maßerweiterung
Ext-Funktor
Computeranimation
Software Engineering
Trigonometrische Funktion
Sichtenkonzept
Ganze Abschließung
Rechter Winkel
Ganze Abschließung
Familie <Mathematik>
Ikosaeder
Speicherabzug
Maßerweiterung
Elektronische Publikation
Ext-Funktor
Computeranimation
Data Encryption Standard
Nichtlinearer Operator
Dean-Zahl
Strömungsrichtung
Ikosaeder
Computeranimation
Konfiguration <Informatik>
Homepage
Objekt <Kategorie>
Informationsmodellierung
Diskrete-Elemente-Methode
Funktion <Mathematik>
Inhalt <Mathematik>
URL
Indexberechnung
Bildgebendes Verfahren
Software Engineering
Aggregatzustand
Data Encryption Standard
Metropolitan area network
Addition
Ganze Abschließung
Polarkoordinaten
Implementierung
Computeranimation
Funktion <Mathematik>
Standardabweichung
Mittelwert
Ganze Abschließung
Gerichteter Graph
Gerade
Computeranimation
Metropolitan area network
Fahne <Mathematik>
Ganze Abschließung
Arbeitsplatzcomputer
Kantenfärbung
Maßerweiterung
Automorphismus
Ext-Funktor
Funktion <Mathematik>
Mittelwert
Informationsmodellierung
Sichtenkonzept
t-Test
Partikelsystem
Information
Kantenfärbung
Einflussgröße
Computeranimation
Haar-Integral
Funktion <Mathematik>
Webforum
Parametersystem
Satellitensystem
Physikalisches System
Knoten <Statik>
Elektronische Unterschrift
Computeranimation
Portscanner
Deskriptive Statistik
Rechter Winkel
Parametersystem
p-Block
Optimierung
Gerade
Funktion <Mathematik>
Aggregatzustand
Logik höherer Stufe
Sichtbarkeitsverfahren
Konfiguration <Informatik>
Funktion <Mathematik>
Code
Parametersystem
p-Block
Knoten <Statik>
Ordnung <Mathematik>
Computeranimation
Parametersystem
Unterring
Erweiterte Realität <Informatik>
Konfiguration <Informatik>
Vererbungshierarchie
Wasserdampftafel
Ablöseblase
Ungerichteter Graph
Default
Ereignishorizont
Computeranimation
Konfiguration <Informatik>
Autorisierung
Tabusuche
Selbst organisierendes System
Kartesische Koordinaten
Computeranimation
Arithmetisch-logische Einheit
W3C-Standard
Metropolitan area network
Domain-Name
Bildschirmmaske
Benutzerbeteiligung
Generator <Informatik>
Druckertreiber
Verschlingung
Automatische Indexierung
Stichprobenumfang
Datenerfassung
Maßerweiterung
Große Vereinheitlichung
Ext-Funktor
Metropolitan area network
Multiplikation
Formale Sprache
Varianz
Zellularer Automat
Translation <Mathematik>
Quellcode
Quick-Sort
Code
Computeranimation
Logik höherer Stufe
Resultante
Sequenzdiagramm
Einfügungsdämpfung
Web Site
Subtraktion
Vervollständigung <Mathematik>
Quader
Wasserdampftafel
Versionsverwaltung
Physikalisches System
Computeranimation
Videokonferenz
Metropolitan area network
Client
Bildschirmmaske
Datenfeld
Konditionszahl
Dateiformat
Maßerweiterung
Extreme programming
Schlüsselverwaltung
Baum <Mathematik>
Roboter
Red Hat
Computeranimation

Metadaten

Formale Metadaten

Titel Sphinx autodoc: automated API documentation
Serientitel EuroPython 2015
Teil 107
Anzahl der Teile 173
Autor Shimizukawa, Takayuki
Lizenz CC-Namensnennung - keine kommerzielle Nutzung - Weitergabe unter gleichen Bedingungen 3.0 Unported:
Sie dürfen das Werk bzw. den Inhalt zu jedem legalen und nicht-kommerziellen Zweck nutzen, verändern und in unveränderter oder veränderter Form vervielfältigen, verbreiten und öffentlich zugänglich machen, sofern Sie den Namen des Autors/Rechteinhabers in der von ihm festgelegten Weise nennen und das Werk bzw. diesen Inhalt auch in veränderter Form nur unter den Bedingungen dieser Lizenz weitergeben
DOI 10.5446/20209
Herausgeber EuroPython
Erscheinungsjahr 2015
Sprache Englisch
Produktionsort Bilbao, Euskadi, Spain

Technische Metadaten

Dauer 36:27

Inhaltliche Metadaten

Fachgebiet Informatik
Abstract Takayuki Shimizukawa - Sphinx autodoc: automated API documentation Using the automated documentation feature of Sphinx, you can make with ease the extensive documentation of Python program. You just write python function documents (docstrings), Sphinx organizes them into the document, can be converted to a variety of formats. In this session, I'll explain a documentation procedure that uses with sphinx autodoc and autosummary extensions. Description: Sphinx provides autodoc feature that generate document from docstring in your python sources. The docstring that contains description and example of the use of function written near the program, makes doc easy to update. In addition, the output of the Sphinx will make you understand what to write in docstring. As a result, this will improve your motivation of doc writing. To use the autodoc, you must specify python modules to automodule directive one by one. This is a tedious task, hoswever autosummary extension automate this task. In most cases, once developers have developed the API, you only need to run the make html of Sphinx, you get a nicely formatted document. Sphinx also has coverage and doctest extentions. These support writing the documentation to work with autodoc. This allow you to check the APIs that have not been documented or you can verify each doctest part is correct or not. If you use such autodoc-related extensions, you can create a Sphinx API documentation in the following procedure. 1. make coverage; you can get the APIs that have not been documented. 2. Write docstrings that includes the doctest format how to use the API. 3. make doctest; you can verify each doctest part is correct or not. 4. make html; you can generate the HTML or your favorite format. In this session, I'll explain a documentation procedure that uses with sphinx autodoc, autosummary, coverage and doctest extensions. Target: - Python programmer who is struggling with documentation. - Python library author who want to generate API docs automatically. - Python library author who want to create a clear documentation which contains python snippets. Outline: * Self introduction (2 min) * Sphinx introduction (2 min) * What is Sphinx? * Sphinx examples * Have you written API docs for your code? (2 min) * I don't know what/where should I write. * Docstrings is needed? Are there some specific format? * Getting start Sphinx (2 min) * How to install Sphinx * How to start a Sphinx project * Generate API docs from your python code (5 min) * setup autodoc extension * write docstrings for yuor python module * "automodule & make html" will generate API docs from python code * autodoc pros & cons: docs for many modules * Listing APIs automatically (5 mins) * setup autosummary extension * how to use autosummary directive * no more autodoc directive * Discovering undocumented APIs (5 min) * setup coverage extension * make coverage * Detect deviations of the impl and doc (5 min) * setup doctest extension * make doctest * Overall picture, tips, Q&A (10 min) * Overall picture of the process * Options for autodoc * translate them into other langs
Schlagwörter EuroPython Conference
EP 2015
EuroPython 2015

Ähnliche Filme

Loading...