Тёмный
No video :(

Carol Willing - Practical Sphinx - PyCon 2018 

PyCon 2018
Подписаться 21 тыс.
Просмотров 33 тыс.
50% 1

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

Опубликовано:

 

12 авг 2024

Поделиться:

Ссылка:

Скачать:

Готовим ссылку...

Добавить в:

Мой плейлист
Посмотреть позже
Комментарии : 14   
@ZhihengLin
@ZhihengLin 6 лет назад
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
@hardikvasa6445
@hardikvasa6445 5 лет назад
Excellent. Best starting guide on Sphinx.
@WaylonWalker
@WaylonWalker 6 лет назад
Talk starts @ 3:00 for those watching
@Bhuyakasha
@Bhuyakasha 5 лет назад
>>for those watching... as opposed to those not watching?
@dullbananas9901
@dullbananas9901 5 лет назад
thank you
@mvaliente2001
@mvaliente2001 4 года назад
Excellent presentation! Direct, useful and to the point!
@TeazaneOwlong
@TeazaneOwlong 4 года назад
Very great presentation ! Now everything seems clear enough to add Sphinx to my projects !
@arthurcgusmao
@arthurcgusmao 3 года назад
Thanks, Carol, this was a really great presentation.
@varenneriocha8712
@varenneriocha8712 3 года назад
Oh, that was marvelous. Thanks a lot!
@davidm.johnston8994
@davidm.johnston8994 3 года назад
Thank you for this talk!
@AnthonyMartinTech
@AnthonyMartinTech 6 лет назад
Carol gives a great talk that's easy to follow and one of the most important things to me does not add unnecessary fluff.
@dom1310df
@dom1310df 3 года назад
I tried using nbsphinx earlier this year. It was such a pain I wish I'd just written everything twice.
@juliocardenas4485
@juliocardenas4485 2 года назад
GREAT !!
@kamalabuhenamostafa
@kamalabuhenamostafa 6 лет назад
Carol, you have a nice Story telling Voice, Impressing.
Далее
Jack Diederich - HOWTO Write a Function - PyCon 2018
41:31