Тёмный

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

Learn Programming with Joel
Подписаться 693
Просмотров 61 тыс.
50% 1

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

Наука

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

 

20 авг 2024

Поделиться:

Ссылка:

Скачать:

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

Добавить в:

Мой плейлист
Посмотреть позже
Комментарии : 46   
@esooghazy
@esooghazy Год назад
Linux users should write "make html" instead of ".\make.bat html".
@ebalogs
@ebalogs Год назад
Actually even windows right now is the same. Windows 11 is slowly shifting to linux.
@Neeoooo
@Neeoooo Год назад
Lifesaver
@krishnarajagopal1964
@krishnarajagopal1964 11 месяцев назад
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
@learnprogrammingwithjoel5654 11 месяцев назад
Glad it helped!
@seamusrohe9226
@seamusrohe9226 Год назад
Great video, right to the point and great speed of explination. Subscribed :)
@learnprogrammingwithjoel5654
Awesome, thank you!
@marvinong
@marvinong Год назад
Thank you so much the excellent guide with clear explanation! 😃👍
@abyssus9934
@abyssus9934 Год назад
very clear explanation! thanks for sharing!
@learnprogrammingwithjoel5654
Glad it was helpful!
@ayanchakraborty943
@ayanchakraborty943 4 месяца назад
That was really helpful, thanks a bunch!
@galbeeri6258
@galbeeri6258 5 месяцев назад
Such a great video. Thank you so much!
@navin1412
@navin1412 Год назад
solid explanation
@pulga5605
@pulga5605 Год назад
Thx, very good video 👍
@kenmiles7409
@kenmiles7409 9 месяцев назад
Hi, can you also make a video, how you made your command line so nice and colorful?.thanks.
@learnprogrammingwithjoel5654
@learnprogrammingwithjoel5654 9 месяцев назад
You can follow this post :www.hanselman.com/blog/my-ultimate-powershell-prompt-with-oh-my-posh-and-the-windows-terminal 😉
@farlfc
@farlfc 7 месяцев назад
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
@learnprogrammingwithjoel5654 7 месяцев назад
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
@Lotus_Feet 4 месяца назад
Try this command sphinx-apidoc -o docs . ..
@smoothoprator
@smoothoprator Год назад
Amazing video thank you..!
@learnprogrammingwithjoel5654
Glad you liked it!
@AbdolaMike
@AbdolaMike 3 месяца назад
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?
@JoseThomaziniImagem
@JoseThomaziniImagem Год назад
Thanks, bro! Thank you very much!
@ziadsalem7014
@ziadsalem7014 5 месяцев назад
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
@RG-ot1vy
@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
@TrendMover
@TrendMover 7 месяцев назад
Awesome video. Do you know Shinx needs, and what do you think about it?
@learnprogrammingwithjoel5654
@learnprogrammingwithjoel5654 7 месяцев назад
Hi, I am not sure if I understood your question.
@ralphblach2952
@ralphblach2952 11 месяцев назад
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
@learnprogrammingwithjoel5654 11 месяцев назад
I am not sure, but it seems the doc string could be wrongly structured leading to the error.
@codeklaudia9696
@codeklaudia9696 10 месяцев назад
Hello. Thank you very very much for this great video. Do you happen to have a github repository?
@learnprogrammingwithjoel5654
@learnprogrammingwithjoel5654 10 месяцев назад
Yes, the link is on the video description :)
@jandiramirez9886
@jandiramirez9886 8 месяцев назад
thanks, you help me :)
@learnprogrammingwithjoel5654
@learnprogrammingwithjoel5654 8 месяцев назад
I'm glad it helped you :)
@shedryn
@shedryn 6 месяцев назад
9:19 и до конца - краткая информация как все задокументировать
@SpiritualCoder1165
@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
@ABN48837
@ABN48837 11 месяцев назад
thanks$
@SoumyaMohanty-ly2pj
@SoumyaMohanty-ly2pj 11 месяцев назад
Thanks. But this does not work on a mac
@learnprogrammingwithjoel5654
@learnprogrammingwithjoel5654 11 месяцев назад
Sorry but I never worked with a Mac machine so I cannot help you in that regard :/
@seamusrohe9226
@seamusrohe9226 Год назад
@learnprogrammingwithjoel5654 please make a video on your VS code setup it looks really cool!
@learnprogrammingwithjoel5654
Are you talking about the PowerShell?
@seamusrohe9226
@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 RU-vid channel for a video explaining the whole setup as well :)
Далее
Python 101: Learn the 5 Must-Know Concepts
20:00
Просмотров 1,1 млн
How to Document Your Code Like a Pro
19:03
Просмотров 89 тыс.
Pydantic Tutorial • Solving Python's Biggest Problem
11:07
Carol Willing - Practical Sphinx - PyCon 2018
27:21
Просмотров 32 тыс.
How To Read Documentations For Beginners
17:02
Просмотров 44 тыс.
11 Tips And Tricks To Write Better Python Code
11:00
Просмотров 609 тыс.
5 Useful F-String Tricks In Python
10:02
Просмотров 296 тыс.