Python Hacks : Quick Start to Sphinx Documentation Tool and Tweaks

Sphinx is a documentation tool from Python. Useful for creating documentation for your libraries, projects, even hand written notes. Built using Python, Makefiles, HTML, CSS, Javaspcript and few other technologies, it is user friendly and seamless to work with.

This video is a quick start to using sphinx.

Useful links:

Do fill this form for feedback: Forum open till 23rd November 2017

All the programs and examples will be available in this public folder!

You can get the files via github from this link:

Follow me in Facebook and twitter:

[gz]

one completely irrelevant comment: to comment multiple lines in vim:

1. put cursor at line 1,
2. in Normal mode, Ctrl+v, cursor up and down to select the lines to comment out,
3. i to enter insert mode, type the # symbol,
4. and finally Esc.

Anyway, thanks for the tutorial.

[carlosdiaz]

Thanks for another useful video Arun, perfect to get started and document my projects!

[carvaka]

Thanks Arun. A very helpful introductory video. Can you suggest me some literature or tutorials to learn more about sphinx? I am really struggling to find resources that I can use to learn this python module. Thanks.

[joelisaacramirezrocha]

Te pasaste de lanza que buena explicacion = you are the man!!! good explication

[vinaybutty]

Hi Arun, This tutorial indeed is an amazing one. I was able to all the things you did. But when I wanted to do something of my own interest. I get this error when i execute make html command. Can you please help.
"Sphinx error:
Source parser for markdown not registered
make: *** [Makefile:20: html] Error 2"

[SaifUlIslam-dixv]

I'm using sphinx-quickstart 3.0.3, I do not get the options for,

i): Source file suffix,
ii): Name your master document,
iii): epub reader?
iv): Please indicate of you want to use one of the following Sphinx extensions

when I run 'sphinx-quickstart'. All I get is,
i): > Separate source and build directories (y/n) [n]: y
ii): > Project name: Testing With Sphinx
> Author name(s): Saif Ul Islam
> Project release []: 1.0.0
iii): > Project language [en]:

[imankalyanmaity]

after successful 'pip install sphinx', I am trying 'sphnix-quickstart' but getting error ''sphnix-quickstart' is not recognized as an internal or external command,
operable program or batch file.'

[rossgeography]

thanks for the upload, you need a better mic and to slow down your delivery a little - I'm a native speaker but I needed the auto-caption on
(sorry to be critical but just feedback)