Merken

MkDocs: Documenting projects with Markdown

Zitierlink des Filmsegments
Embed Code

Automatisierte Medienanalyse

Beta
Erkannte Entitäten
Sprachtranskript
how can and things will come along and yes someone my name is that you must use and
I want full red and primarily on what you want to study the full work time is it is the project of mine also live in Gloucester were around the of local within group and that's probably about all units of the mean and yet another bedroom feeling OK after the party last and the speaking about and so the 1st thing to go away how do you actually pronounce the name of this and that so you can you call it micr adults anchored Doxil make topics I tend to go with them and he which a broadside at some point
so the public can really be that such a local that they point of it was the beyond the project started 10th January 2014 and I was 1 of those planters and codebase originally it was part of speech of the rest of book for basin was not just a single following cannot of be 1 and it actually went back to around September 2012 and so the project was started by time Christie's most people known for his work on general from and then I lost you when Thomas speaking about it at your point and I was in the audience and that's when I started interested and involved in the project I was sitting in the audience and i was going missing on my laptop that as you do and I want to the tail but I noticed that the traversable was failing in that kind of got myself see sensors and I had felt the need to try and fix this film test and that kind of thing I just got stuck in the projects of I did consider breaking builds a dataset having a more quantitative convergence of today and so think about the
project goals and the as the quite simple really will try to do I think and the reason Pfizer really 1 of the project to be something is easy for everyone to use really simple to use on so it's really about making writing good documentation easier and focusing on high-quality prose based augmentation so I'm not really interested in being able to automatically generate documentation based on current that comments on and 1 of the things that people mistake about you and me here I walked in this project this I'm probably due to write and augmentation by actually and I'm probably just as bad start with these writers your response on so this is really it's almost like filter procrastination of avoiding documentation and what tools for and but I want to make is easier as they can for myself and everyone else and trying to improve as well so to solve explain why I mean by high-quality prose documentation of the projects like Django or having maybe Jake real constructive non-Python ones where they the tree that documentation the same way the to code really focusing on sold and crossed machine after it is not something which is generated on after full itself on all and some of these projects prolific API generated augmentation as well but that's very much kind of a site of the documentation so you have you mean part and then is like you can good faith reference you want afterward which can definitely useful in some cases and and we use so drunk while on the last year it's actually really on a recently popular project now and I just talked full of the larger project based on popularity so this is based on things like how big the documentation is and how popular there and you can see where and the 1st 1 you with obvious because Tom wrote project originally posterior um assesses also and again as I and bluster references are distributed is networking file system and that's on the use of a really large uh self-documentation like think and the hundreds of modern files such as 1 has to see there was a lot of such a large part the doctor Python point on and finally faced so as query which has something to do with the cycle of query language for fragments of the body references to individual interest and we we get a lot of users coming from did not so many of you were married adults told that help you wouldn't notice supports so people postings project reveals fall and cannot projects so here you find a lot people want to use with adults from different communities because of the use of family of sort of 2 points and so on and we we don't what people want to use adult but don't want until it all to learn reStructuredText and that kind of overlapped with the slides slightly but it's the 1 really interested is making good documentation tools for everyone and it could be for developers logistic general technical writers is not necessarily about just the Python crowd I want to do something is really happened everyone and it is really to in simple and easy to use so the example that you have a good repository of mountain false and nothing else and told you you tell Rita don't build that they will generate souls a stock and contig following the going this and I do a couple seconds of the required for the building and otherwise it would just walking can always the point and it's just you can make it much easier than that so when you actually
generated documentation and this is why my life and sorry about sequential also development
and working but and so this is the default thing for adults and this is just a Superstruct it's been around a shows a few couple of interesting things about which you are going to like and what and so so this is the main text of the universe and then over and left got the table contents all the top which obviously reflects the front-page navigational top is based on the files go in your documentation and the such appear which issues is limited adjacent to the fragments of changing JavaScript and then just pattern pages so we've know quite a lot of features which are just a few for free essentially when using the and then you can
see the same thing and this is all we did not seem so if you see in minute adults projects on read the documents so you might see someone not realized because of the story like this these things there are a couple tells of you know them well but the as possible on biggest 1 is a very long words as wouldn't and in this program most most popular thing wanting to know is if you are building on Richard Nock stated probably don't make use any of the things than this 1 moment just because of some integration contract to solve established and is tricky for constant used to do so if you want to get started with at
the bureaucrats are that you need
and fit and Python installed obsolete at some point I would like to change that because of the sale to to reach beyond the Python community so be nice to have installed for Windows and Mac and I'm aware of people doing fall Fedora and deviance the food or 1 with is policy that everyone's already of data has happened him on beer a acts at some point be nice to do something official distributions no way to to reach more people because we we do have a lot of people are struggling windows and so on and it's also quite to commit to support them and government but another just to try and told the demagogues and do a demo and inaccessible to
the right but that's somewhat here is gone into your repository the reason for being there was should the reason for being the empty it so it will be in the repository will be apparent and and is commemorated virtual the this not status although very briefly but was that thank sketches but and in this slide you reducing dominant adopts new funds good to into who was in the new and
I don't need to do the directory names I want to do this is going to and that's added up based the file and just pretty adults directory with 1 index and then that is a very simple falls I also want to OK this is just going
for an unfortunate can't see this very easily so that's the way it is defines the name which is huge and then there's a 1 multidimensional which is also but hopefully we should to read those and I'm now at this
point is is that hadn't slides used in adults and this will just what now now look like area thank for that when
there's always outperform the standard which is the purity and the universities most of
right 1 and you can roughly the 1 doing the point I want to make here is that the young and adult watches the files alive and words we also use sockets so refresh the browser automatically together so when I suggested testing title and you should see that the commands and left is know and it's really nice experience with peer editing is very tricky apparently like this but when you obviously Sizemore interesting side by side in working it's really selflessly process to the country and it's also worth noting that I don't want if it and then when you're adding new files they will just fields must be picked up by the
same automatically reloaded and and it's the navigation but because of too small it's going to move 1 word which is a little bit bigger has already been added that now the
company because this directories operated drop-down menus and so on and many
agencies so such watching
here so which is quite nice and actually
really fast because that's all you've done locally and 1 final thing I wanted to to this point was to see if I
can get back to this is the experience of change in the field because
I what really well with the the library so this is my country following the changes in the
last thing that we want to use changes in the kids will you on page and it is quite the quite nice but usually satisfying when you try out different things so we need more things just something to them and then finally to distill finish off
the the full example workflow of how easy the same can be and this is why I learned at the core of a surrogate repository which is among the top there wasn't it 2nd is to include not just the following and takes all moment and now this documentation should be alive on and talking about it will include this that easy-to-use trust me that's on this that I can show any skeptics of organize the presentation but
and so that's disconcerting this the full workflow how usable in a very simple
set up on the energies this really nice and very easy this very well we have to do and then when you
came from the top prediction and start to think about how these possible what together 1 of the 1 of his talk from linking between different sections and and I I discussed life consistently confused some users because basically what you should do is you link to the amount of fall directly even during the build process we we've update of reference so it goes to the student alcohol instead and and in the that is when you browse browser they are not for example the links will still life because it goes between the different what themselves and then when you between different sections you can use angular but which are overhead attacks and I worked really well that's also has its own ideal just when you want to have a chance to try to learn things from becoming still working on improvements of detection and warning about that and you see the configuration file very briefly when I was attempt and I didn't really don't want to tell workers ethologist focus on now basically a young will fall and again that's about users shouldn't have to enter by consultative configuration for the documentation at least ideally and and the only actual country option is required as something which is the 1 used in everything else we self-reliance sensible defaults but you can change the majority of things like where it the contagion from oracles to you what you think all pages are included what John included that we'd like to you've always here is sensible you'd want to include all model calls for example so we just add the more we had most of the navigation and we index on such and so on and I then also shows you the deployment of and I was just 1 of the ways you can deploy variously with adults because the output is just a static website and the pages what's really well the read those integration is great and the estimates of things on top of the dual space to do with different versions and so you you can have different versions of different bills showing like different branches will tighten it the repository and the Python hosted is also really that's the this question which is the shop would actually trying example that we have a good example our documentation in the this is something that such a need master with no problem is to get the compensation answers to do with you cannot package of things and upload them to so starts in which 1 distribution that underpin the ones that were also moving a bunch of orange things out externally so they can be installed rather just included because moment 17 to the development of watch ones which slightly think differently about things but the maintenance of the positive pairs from say I'm when this happens will then be able to but I will see what increase number theory available and will be able to reuse some the ones that people are currently distributing also including in this source because of the we can can really do it just which is by using the directory and and providing a local path which is ideal and those beyond that we're at time counting have been pressure from 1 point on this this set of vectors say that it for about 6 months so and I initially started and I was like really want to refer to this is possible by step back a bit and I'm I'm just trying to solve carefully at features and then will get there get there at the end of the day I could hold current version will want to make use of it but getting the goal is to model to enable features of moment were really FIL level future complete it's more about policy and things like that and what really well there are a couple additions on considering try again for which is a much better support from polarization that internationalization of at the moment people can use usually code wine with lunch at once it gets tricky when you want to support multiple languages and and also that building multiple versions as something fundamentally about what it is helpful to me process for people with something default because it's a fairly common patterns is something that we struggle with on intraductal itself that whenever I could we do release and builds a new feature account updated documentation with anything else until the new the new version is released OK and and that actually so brings me to the departure level quickly and convince me to the the end where you take care of questions about the project will present should know about it and there's some of my contact details of you know that 1 find a moral speak to me later and I'm also going to spend on Saturday load and what to do during what was and ever
I think you have a lot of patients may be additional information information from do you have any problem that's and products last through the docks brought to the links and don't altering and in my experience the use of dogs laughter and conduct yeah breaks links even at them out that it and do have this that and the other thing that is known as the most in unaware of any European but divided by be happy to take a look after I k and some of them could not see this by the model are found on only news that supports only a fast nationals are marked down long and low expensive extinctions and are we can use extensions that can be defined in the and out country collocates sense and can you will also going to say some thing can tell us some about some molecules that's coming out stinks docstrings thinks that brought the money on the canon because I use right now the dog and the so that when you and was so intense all of and hopefully and draw docstrings and your documentation yeah and so we don't really have any good support moment it's something but I don't think we really want to have that in in the adults itself what would you like to do is to do something 1 of over the plug-in API this is is something that people want but this so different variations of yeah we include something by the following from 1 that we were trying to say the more general and so you're not really going to have a moment I'm aware of some people they call some tools to get out which then outputs knocked down and then they just build the model and actually looks pretty good i've admired and in the process I give thanks and so on are last problem I think in that supports only at 2 levels the links in the morning and I know that you that was fixed around a couple months ago I don't know what to say yet think the animals like you're more questions for the as it would be a major reason for using this both students within our for what people is simply not enough or it's and I think I might be mentioned just as before you come and but it's fine and so a lot people want to use we developed for example but they are not from Python background so they don't want by tooling and we don't want to land reStructuredText because typically you only know that you but of and they I mean for me it's just reveals states of the images yeah that was that's what really broad emission but was it in here so that that to support like I told highlighting but if I want to write some so I didn't like how you name I can do that write code right yet but stand somehow signal that type the language so you can get the and this isn't included this is this called friends because what need to like 3 takes the need to the name of language and then you write code book and 3 will tactics and that you can say which languages then and we we definitely to improve ultraviolet I want to know what the moment it testifies to the scene so that means people using them using JavaScript libraries to do and then not not as it is and listening to you there were questions we want to do to that thank
Arithmetisches Mittel
Metropolitan area network
Punkt
Einheit <Mathematik>
Gruppenkeim
Vorlesung/Konferenz
Projektive Ebene
Sprachsynthese
Computeranimation
Data Mining
Subtraktion
Web Site
Punkt
Annulator
Familie <Mathematik>
Sprachsynthese
Computeranimation
Eins
Netzwerktopologie
Virtuelle Maschine
Polygonzug
Reelle Zahl
Endogene Variable
Freier Ladungsträger
Retrievalsprache
Dateiverwaltung
Logistische Verteilung
A-posteriori-Wahrscheinlichkeit
Softwareentwickler
Hilfesystem
Softwaretest
Konstruktor <Informatik>
Dokumentenserver
REST <Informatik>
Güte der Anpassung
Zwei
Gebäude <Mathematik>
Abfrage
Elektronische Publikation
Quick-Sort
REST <Informatik>
Rechenschieber
Erweiterte Realität <Informatik>
Zustandsdichte
Mereologie
Dreiecksfreier Graph
Projektive Ebene
Steuerwerk
Metropolitan area network
Videospiel
Folge <Mathematik>
Mustersprache
Inhalt <Mathematik>
Elektronische Publikation
Softwareentwickler
Default
Grundraum
Computeranimation
Tabelle <Informatik>
Homepage
Metropolitan area network
Zustandsdichte
Momentenproblem
Wort <Informatik>
Projektive Ebene
Extrempunkt
Optimierung
Computeranimation
Demo <Programm>
Design by Contract
Integral
Rechenschieber
Metropolitan area network
Distributionstheorie
Diskrete-Elemente-Methode
Punkt
Dokumentenserver
Total <Mathematik>
Bildschirmfenster
Kontextbezogenes System
Computeranimation
Informationssystem
Demo <Programm>
Data Encryption Standard
Elektronische Publikation
Indexberechnung
Elektronische Publikation
Information
Speicherbereichsnetzwerk
Computeranimation
Metropolitan area network
Diskrete-Elemente-Methode
Zustandsdichte
Automatische Indexierung
Ruhmasse
Reelle Zahl
Gravitationsgesetz
Verzeichnisdienst
Ideal <Mathematik>
Elektronische Publikation
Punkt
Indexberechnung
Extrempunkt
Information
Speicherbereichsnetzwerk
Computeranimation
Rechenschieber
Metropolitan area network
Diskrete-Elemente-Methode
Flächeninhalt
Zustandsdichte
Thetafunktion
Ruhmasse
Reelle Zahl
Gammafunktion
Elektronische Publikation
Gruppe <Mathematik>
Browser
Regulärer Ausdruck
Indexberechnung
Extrempunkt
Information
Speicherbereichsnetzwerk
Computeranimation
Portscanner
Metropolitan area network
Diskrete-Elemente-Methode
Zustandsdichte
Ruhmasse
Reelle Zahl
Ideal <Mathematik>
Hacker
Logik höherer Stufe
Softwaretest
Prozess <Physik>
Punkt
Browser
Browser
Indexberechnung
Peer-to-Peer-Netz
Extrempunkt
Elektronische Publikation
Socket-Schnittstelle
Computeranimation
Homepage
Metropolitan area network
Softwaretest
Datenfeld
Zustandsdichte
Wort <Informatik>
Grundraum
Baum <Mathematik>
Standardabweichung
Metropolitan area network
Bit
Diskrete-Elemente-Methode
Softwaretest
Zustandsdichte
Wort <Informatik>
Verzeichnisdienst
Computeranimation
Server
Punkt
Elektronische Publikation
Browser
Indexberechnung
Einfach zusammenhängender Raum
Extrempunkt
Information
Speicherbereichsnetzwerk
Computeranimation
Metropolitan area network
Softwaretest
Diskrete-Elemente-Methode
Zustandsdichte
Logik höherer Stufe
Webforum
Dualitätstheorie
Mathematisierung
Indexberechnung
Hausdorff-Raum
Extrempunkt
Computeranimation
Homepage
Metropolitan area network
Softwaretest
Zustandsdichte
Disk-Array
Programmbibliothek
Ruhmasse
Normalvektor
Elektronische Publikation
Momentenproblem
Dokumentenserver
Singularität <Mathematik>
Browser
Regulärer Graph
Indexberechnung
Einfach zusammenhängender Raum
Information
Zahlensystem
Computeranimation
Metropolitan area network
Verzeichnisdienst
Diskrete-Elemente-Methode
Garbentheorie
Zustandsdichte
Verschlingung
Datenerfassung
Dynamisches RAM
Statistische Analyse
Speicherabzug
Bitrate
Demo <Programm>
Distributionstheorie
Bit
Konfiguration <Informatik>
Prozess <Physik>
Punkt
Momentenproblem
Desintegration <Mathematik>
t-Test
Versionsverwaltung
Regulärer Graph
Bidualraum
Extrempunkt
Computeranimation
Homepage
Eins
Übergang
Mustersprache
Vorlesung/Konferenz
Default
Funktion <Mathematik>
Addition
Vervollständigung <Mathematik>
Dokumentenserver
Singularität <Mathematik>
Konfiguration <Informatik>
Softwarewartung
Druckverlauf
Garbentheorie
Menge
Polarisation
Verschlingung
Internationalisierung <Programmierung>
Projektive Ebene
Garbentheorie
Versionsverwaltung
Lesen <Datenverarbeitung>
Subtraktion
Web Site
MP3
Code
Multiplikation
Informationsmodellierung
Konstante
Softwareentwickler
Konfigurationsraum
Schätzwert
Videospiel
Verzweigendes Programm
Vektorraum
Elektronische Publikation
Binder <Informatik>
Fokalpunkt
Gerade
Integral
Portscanner
Energiedichte
Elementare Zahlentheorie
Last
Orakel <Informatik>
Codebuch
Sichtbarkeitsverfahren
TVD-Verfahren
Subtraktion
Prozess <Physik>
Momentenproblem
Formale Sprache
t-Test
Schreiben <Datenverarbeitung>
Code
Übergang
Demoszene <Programmierung>
Metropolitan area network
Informationsmodellierung
Datentyp
Programmbibliothek
Kontrollstruktur
Vorlesung/Konferenz
Maßerweiterung
Bildgebendes Verfahren
Addition
Güte der Anpassung
Gibbs-Verteilung
Kontextbezogenes System
Biprodukt
Binder <Informatik>
Rechter Winkel
Information
Wärmeleitfähigkeit
Aggregatzustand

Metadaten

Formale Metadaten

Titel MkDocs: Documenting projects with Markdown
Serientitel EuroPython 2015
Teil 34
Anzahl der Teile 173
Autor Matthews, Dougal
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/20103
Herausgeber EuroPython
Erscheinungsjahr 2015
Sprache Englisch
Produktionsort Bilbao, Euskadi, Spain

Technische Metadaten

Dauer 22:32

Inhaltliche Metadaten

Fachgebiet Informatik
Abstract Dougal Matthews - MkDocs: Documenting projects with Markdown MkDocs is a Python library for creating documentation with Markdown. The primary goal of the project is to lower the barrier for documentation writers and to help enable high quality prose based documentation. The primary maintainer of MkDocs will cover the following topics: - An introduction to MkDocs and the project goals. - How and why did the project start? - Who uses MkDocs today? - Discuss what we need to do to create great documentation and how MkDocs can help. - A tour of the key features currently in MkDocs - Adding MkDocs to your project. - Using themes in the documentation and making customisations - Publishing your documentation with ReadTheDocs and GitHub pages. - A look at the up and coming features in MkDocs and how you can help make these happen. - A comparison with Sphinx and why you should consider MkDocs.
Schlagwörter EuroPython Conference
EP 2015
EuroPython 2015

Ähnliche Filme

Loading...