python3 sphinx documentation generator

python3 sphinx auto document generator
sphinx-doc.org/
notes
github.com/thesheff17/youtube...

[@DanSheffner]

This video is getting pretty old and uses python 2. Python 2 is is no longer supported as of January 1st, 2020. I will leave it up for reference purposes. The concepts in this video still apply. Please use python 3 and above now. Visit www.python.org/ for more information.

[@MsDakota7]

I quite literally spent 6 hours trying to find a good explanation for my use case. This covers it super well and easy to understand. Straight to the point how to auto generate your documentation. Nothing more or less

[@ddavid2]

Many thanks for sharing your knowledge. After many pages and docs read, your video was the one that helped me more

[@QuoVadis84]

12:15 You can fix the warning by adding one line to the index.rst. Just put an empty line after ':caption: Contents:' Then in the next line type 'modules' . This line should have the same indent as ':caption: Contents:'

[@evilwizard7931]

I'm just going to say a big Thank You from 2021. After a trying to get the thing to pick up on the source files to read the docstrings to generate the rst to build the html & failing because most of the tutorials are not the same anymore, but showing the conf it generated & then the actual command to generate the rst files

[@jyotioh3723]

Thanks for a tutorial that shows using some code/project!

[@salmann94]

Nice work. The best available of it's kind !

[@DanSheffner]

Thanks for watching.

[@yuriwrlk]

Very informative, thanks!!!

[@karthikarumugam7907]

@Dan Sheffner How can i work on the same with python based on windows. Any link will help

[@Turjak_art]

thanks awsome explanation

[@DanSheffner]

Thanks for watching!

[@불광불급]

Thanks a lot! Very helpful.

[@DanSheffner]

+이창영 Thanks for watching.

[@chenginsea210]

Great Job, Thanks for your sharing.

[@DanSheffner]

Thanks for watching.

[@mrcrash4974]

Very good tutorial!!

[@BioniXdu25]

I think it's because I'm an idiot but ... when I first write apt-get update it says : zsh: command not found: apt-get I'm on Windows and I use Babun terminal, I hope I'll have a reply

[@DanSheffner]

I'm not too familiar with the zsh command line. I would try bash and see if you have similar results.

[@abhishekmhamane615]

From line-4 to line-29, you have info about the License and copyrights. I was wondering is there a standard way as per PEP-8 to write the authorship and metadata info.

[@DanSheffner]

I don't think pep-8 has too many recommendations about the license banner. For my newest projects I create LICENSE file in the git repo and then leave it out of the files for a cleaner repo. Here is an example: github.com/thesheff17/tf_examples/ github.com/thesheff17/tf_examples/blob/main/LICENSE With this LICENSE file I assume all files in this repo are under the GPL license.

[@SaifUlIslam-di5xv]

You gained a subscriber!

[@DanSheffner]

Thank you very much.

[@dLantee]

The best explanation how to generate documentation for python source code.

[@DanSheffner]

thanks for watching.

[@poonamkale8216]

will you suggest how to resolve "autodoc failed to import module in sphinx" error

[@DanSheffner]

I haven't had to use sphinx in a long time and this video is also getting pretty old at this point. Are you still having this problem? If you can join the discord server I can troubleshoot more. Hopefully you were able to figure this out. Thanks for watching. :)

[@sachinrai8181]

Thx for this help

[@Dan-th2wr]

hi Dan great video... any idea how to make search work with substrings / infix?

[@DanSheffner]

hmmm...this is a good question. I tested on the python docs and I just searched for the word ommand and everything that matched *ommand was returned docs.python.org/3/search.html?q=ommand also sometimes google is a better sub string search tool. You can do site:docs.python.org os.system and this will return results only from the site you want. Hopefully this helps.

[@alexluwees3484]

Hey great video! I am trying to learn how Sphinx works, and I actually have an assignment on it. I am supposed to make the Quick search tool of Sphinx to support both absolute and relative paths. I really dont know what that means haha any ideas ? :)

[@RomanGWatch]

Great, Thank you

[@DanSheffner]

great to hear this video helped. :)

[@Simba-qm5qs]

How to install a sphinx theme such as 'natural' with pip and conf.py ? I have some troubles. Can you explain me with easy words (I'm French lol) ? Thanks. By the way, Nice tutorial. Have a good day.

[@erfelipe]

Thanks

[@romulorocha947]

python 2.7 or 3.4? what is the better?

[@DanSheffner]

always use python 3.x at this point unless you have a specific reason to use python 2.7. python 2.7 end of life is in 2020 so it is only supported for a couple more years.

[@neemaogega402]

I am new to python and sphinx..I need step by step instructions on how to install these in windows 10 kindly.

[@safesploit]

As you're a beginner, I cannot suggest this. Instead, begin by using a Linux based distro, like Ubuntu. As this contains APT which makes initial setup and future learning easier, as more documentation is written. You can use Ubuntu within VirtualBox.

[@josephcox3091]

super annoying to have the KZbin time bar over your commands. Anytime I pause to see what your typing the red bar is in the way

[@DanSheffner]

Thank you for this feedback I will change this in future videos.