Python docs offline?
#1
I am wondering if anyone has a way of getting the Python documents in a offline format. What I've done with the skinning manual is saved the webpage.html this allowing me to browse the webpage when I am offline, as some of my late night work is not always on a PC with good internet connection.

So I am wondering if anyone has a way to make the more complex Python docs work in the same manner?
Reply
#2
I installed a doxygen gui app for windows (think it might be multi-platform) and was able to create a local html for some other of the documentation, so I think it is possible.  But it wasn't simple to setup so would take some work to figure out how for the complete Kodi docs, or at least the Python subset.

scott s.
.
maintainer of skin  Aeon MQ5 mods for post-Gotham Kodi releases:
Krypton
Leia
Reply
#3
Thanks I will take a look.
Reply
#4
You can also simply clone the xbmc repo locally, install doxygen and run it on the docs/ doxygen folder :

https://github.com/xbmc/xbmc/blob/master.../README.md

The generated html will be located in an html folder 1 directory above
Reply
#5
Full Doxygen docs may be overkill here. May I suggest Kodistubs: https://github.com/romanvm/Kodistubs ? They are based on the official docs and include only Kodi Python modules.
For generating HTML docs you will need Python 2.7:
- Create a virtual environment (optional).
- Install dependencies: pip install -r requirements.txt
- Go to /docs directory and run make html there.
Raspberry PI 2 + LibreELEC 8 (Kodi 17)
Samsung Galaxy Tab A 10.1 + Kodi 17 for Android
Reply
#6
(Yesterday, 08:09)Roman_V_M Wrote: Full Doxygen docs may be overkill here. May I suggest Kodistubs: https://github.com/romanvm/Kodistubs ? They are based on the official docs and include only Kodi Python modules.
For generating HTML docs you will need Python 2.7:
- Create a virtual environment (optional).
- Install dependencies: pip install -r requirements.txt
- Go to /docs directory and run make html there.

This actually may be better. Will definitely be useful. and chance you have a list of all the tags that are defined in the nfo files? haha
Reply
 
Thread Rating:
  • 0 Vote(s) - 0 Average



Logout Mark Read Team Forum Stats Members Help
Python docs offline?00