Sphinx - How to generate documentation from python doc strings - Five + Minutes on Tips and Tricks

This tutorial teaches you how to configure and use sphinx to generate HTML documentation from your project 's python doc strings.
Code: github.com/lpw...
Social Media
Twitter: / lpwjoel
Music: Royalty Free Music from Bensound

[@alla-anastasiiagnatkiv2193]

Amazing concise tutorial!

[@krishnarajagopal1964]

Thanks a Lot for the step by step instructions and it really helped me to create the Simple API documentation that I was looking for

[@learnprogrammingwithjoel5654]

Glad it helped!

[@esooghazy]

Linux users should write "make html" instead of ".\make.bat html".

[@ebalogs]

Actually even windows right now is the same. Windows 11 is slowly shifting to linux.

[@Neeoooo]

Lifesaver

[@abyssus9934]

very clear explanation! thanks for sharing!

[@learnprogrammingwithjoel5654]

Glad it was helpful!

[@seamusrohe9226]

Great video, right to the point and great speed of explination. Subscribed :)

[@learnprogrammingwithjoel5654]

Awesome, thank you!

[@marvinong]

Thank you so much the excellent guide with clear explanation! 😃👍

[@ayanchakraborty943]

That was really helpful, thanks a bunch!

[@galbeeri6258]

Such a great video. Thank you so much!

[@AbdolaMike]

awesome video! definitely need to use this for a project! Quick question, if my tests are in a separate location at the root do I run sphinx-apidoc -0 twice? once for src and once for tests every time i want to generate?

[@navin1412]

solid explanation

[@RG-ot1vy]

This is kinda off topic, but what powerline theme are you using? Maybe it’s the video quality, but it almost looks 3D, like it has a gradient or something.

[@learnprogrammingwithjoel5654]

You can follow this tutorial: www.hanselman.com/blog/my-ultimate-powershell-prompt-with-oh-my-posh-and-the-windows-terminal

[@farlfc]

What if the project contains multiple sub directories under src which in turn have more sub directories? How do we create Sphinx documentation for that?

[@learnprogrammingwithjoel5654]

I would say to use the init.py file inside the nested folders, so the sphinx tool recognizes it. But I am not sure about your use case :/

[@Lotus_Feet]

Try this command sphinx-apidoc -o docs . ..

[@kenmiles7409]

Hi, can you also make a video, how you made your command line so nice and colorful?.thanks.

[@learnprogrammingwithjoel5654]

You can follow this post :www.hanselman.com/blog/my-ultimate-powershell-prompt-with-oh-my-posh-and-the-windows-terminal 😉

[@smoothoprator]

Amazing video thank you..!

[@learnprogrammingwithjoel5654]

Glad you liked it!

[@pulga5605]

Thx, very good video 👍

[@ziadsalem7014]

Hi, Thank you fro the intersting explanation. i am trying to use sphnix for vhdl code but it is not possible to install the extension (pip -m install sphinxcontrib-vhdl ). I get an error message: ERROR: Could not find a version that satisfies the requirement sphinxcontrib-vhdl (from versions: none) ERROR: No matching distribution found for sphinxcontrib-vhdl. did anyone try that extension? thanks

[@JoseThomaziniImagem]

Thanks, bro! Thank you very much!

[@TrendMover]

Awesome video. Do you know Shinx needs, and what do you think about it?

[@learnprogrammingwithjoel5654]

Hi, I am not sure if I understood your question.

[@codeklaudia9696]

Hello. Thank you very very much for this great video. Do you happen to have a github repository?

[@learnprogrammingwithjoel5654]

Yes, the link is on the video description :)

[@SpiritualCoder1165]

Thanks a lot, which terminal extension are you using in here ?

[@learnprogrammingwithjoel5654]

www.hanselman.com/blog/my-ultimate-powershell-prompt-with-oh-my-posh-and-the-windows-terminal

[@jandiramirez9886]

thanks, you help me :)

[@learnprogrammingwithjoel5654]

I'm glad it helped you :)

[@ABN48837]

thanks$

[@shedryn]

9:19 и до конца - краткая информация как все задокументировать

[@seamusrohe9226]

@learnprogrammingwithjoel5654 please make a video on your VS code setup it looks really cool!

[@learnprogrammingwithjoel5654]

Are you talking about the PowerShell?

[@seamusrohe9226]

@@learnprogrammingwithjoel5654 Ya the terminal. It's showing you possible flags you can pass in and the themes look helpful. It would be awesome to see what it all means and how you set it up.

[@learnprogrammingwithjoel5654]

You can follow this: www.hanselman.com/blog/my-ultimate-powershell-prompt-with-oh-my-posh-and-the-windows-terminal

[@learnprogrammingwithjoel5654]

You can look on his KZbin channel for a video explaining the whole setup as well :)

[@SoumyaMohanty-ly2pj]

Thanks. But this does not work on a mac

[@learnprogrammingwithjoel5654]

Sorry but I never worked with a Mac machine so I cannot help you in that regard :/

[@ralphblach2952]

I followed your directions and keep getting the results below Any Suggestions? WARNING: autodoc: failed to import module 'rfm69_sr' from module 'rfm69_sr'; the following exception was raised: No module named 'rfm69_sr.rfm69_sr'; 'rfm69_sr' is not a package /home/pi/rfm_test/rfm69_sr/rfm69_sr.py:docstring of rfm69_sr.Tracker.check_file:4: WARNING: Field list ends without a blank line; unexpected unindent. looking for now-outdated files... none found pickling environment... done checking consistency... /home/pi/rfm_test/rfm69_sr/docs/modules.rst: WARNING: document isn't included in any toctree /home/pi/rfm_test/rfm69_sr/docs/rfm69_sr.rst: WARNING: document isn't included in any toctree

[@learnprogrammingwithjoel5654]

I am not sure, but it seems the doc string could be wrongly structured leading to the error.