Carol Willing - Practical Sphinx - PyCon 2018
Speaker: Carol Willing
Each member of your project team uses something different to document
their work -- RestructuredText, Markdown, and Jupyter Notebooks. How do
you combine all of these into useful documentation for your project's users.
Sphinx and friends to the rescue!
Learn how to integrate documentation into your everyday development
workflow, apply best practices, and use modern development tools and
services, like Travis CI and ReadTheDocs, to create engaging and up-to-date
documentation which users and contributors will love.
Slides can be found at: speakerdeck.com/pycon2018 and github.com/PyCon/2018-slides
Пікірлер: 14
5:00 Basics: install sphinx, create a project, file structures, build and serve 8:22 Words: source format (reStructuredText, Markdown, Notebooks, pandoc), content first, quality latter, spelling check tools 13:50 Visuals: images, directives (warning, see also, code, etc.) 15:43 Structure: toctree, caption 17:00 Workflow: testing, automate, host, monitoring, feedback 19:43 Extensions: autodoc, generating documentation by docs strings 22:00 Sphinx, JavaScript and Beautiful Design: pros of Sphinx, communities, comparison with JavaScripts tools, themes, customization
Excellent. Best starting guide on Sphinx.
Excellent presentation! Direct, useful and to the point!
Talk starts @ 3:00 for those watching
@Bhuyakasha
5 жыл бұрын
>>for those watching... as opposed to those not watching?
@dullbananas9901
5 жыл бұрын
thank you
Oh, that was marvelous. Thanks a lot!
Very great presentation ! Now everything seems clear enough to add Sphinx to my projects !
Thanks, Carol, this was a really great presentation.
Carol gives a great talk that's easy to follow and one of the most important things to me does not add unnecessary fluff.
Thank you for this talk!
I tried using nbsphinx earlier this year. It was such a pain I wish I'd just written everything twice.
GREAT !!
Carol, you have a nice Story telling Voice, Impressing.