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
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?
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?
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
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.
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 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.