Better Documentation about python-plexapi HOT 10 CLOSED

This is getting there (slowly). I'll be out of town this weekend, but expect to finish reviewing and adding to everything next week at which time we can look into publishing to Read The Docs. After this is done, I'd love to look into the new test suite and get that running cleaning on TravisCI. @Hellowlol, you did an amazing first pass on this, thanks so much!

A few guidelines I was following to make it a bit easier.

• No need to document dunder functions (__init__, __repr__, etc).
• No need to over-document private methods (_functions).

Completed: Audio, Client, Config, Exceptions, Library, MyPlex, Utils
Remaining: Media, Photo, Playlist, Playqueue, Server, Sync, Video

BTW: You can see documentation now if you install sphinx, goto the docs folder and run "make html".

pip3 install sphinx, sphinx-autobuild, sphinx-rtd-theme, sphinxcontrib-napoleon
cd <python-plexapi>/docs
make html

from python-plexapi.

Closing this one. There is still some work to do for docs, but we're well on our way and its part of the build system now!

http://python-plexapi.readthedocs.io/en/latest/?badge=latest

from python-plexapi.

Unfortunately, not yet. I never had the time to put into better docs. :(

from python-plexapi.

No worries, that's understandable as it would require a significant portion of time to do so.

Thanks for the response

from python-plexapi.

A lot of work was already put in by @Hellowlol for this. I also started another branch to take that work and format it for Sphinx documentation after which we'll get this up on ReadTheDocs. I suspect this will take a few weeks to fully clean things up.

from python-plexapi.

Can't we use the extension Napoleon with spinx? I choose google docs style since that is the most human readable.

from python-plexapi.

Of course, I was hoping you would chime in. I never used Spinx before, don't know much about it or the best approach.

from python-plexapi.

Afraid i dont know anything about it. Never used it but im sure we can figure it out.

from python-plexapi.

We should use Napoleon to parse the google docstyle to rst to it passes this to sphinx before building docs. I choose google docs style because imo its the most readable docstring type. Changing this to rst manually would make the docs harder to read and would be a huge task.

extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.napoleon']

See http://sphinxcontrib-napoleon.readthedocs.io/en/latest/

from python-plexapi.

Awesome stuff. How are you solving this?. Are you editing adding the classes manually.? Or using some kind of tool? . I don't know why i didn't add proper classes in the first go. Anyway thank you so much.

from python-plexapi.