API Docs about python-mpd2 HOT 9 CLOSED

Python-Doc would be really need. In the meantime I have only this listing here:

https://github.com/Mic92/python-mpd2/blob/master/doc/commands.rst

which could be combined with this one:

http://www.musicpd.org/doc/protocol/

Most commands are generated. All not generated commands are mentioned in the readme

Since it was started as a fork, with the intention to be merged back into the origin project at some point, I never wrote my own documentation.
A first step would be to import the old examples from here:

http://jatreuman.indefero.net/p/python-mpd/page/Examples/

and add more information to the command listing

from python-mpd2.

Thanks for the quick response!

I'm familiar with the old library, and the docs there, so I started off using that and then reviewing the source code. Plus tinkering in a Python terminal... And I completely missed the doc folder!

I suppose the starting point is adding parameter names for each method call. Sphinx is probably a good idea too. I'll make a start if I have some time in the next week or so..

from python-mpd2.

Do you have experience with sphinx? It would be great, if you could add a basic template. So we continue from there.

from python-mpd2.

Any updates on this subject?

from python-mpd2.

I think that at least for the commands an API documentation would be redundant; a link to MPD's protocol spec and a few examples should suffice, because it is really just the same in almost all cases.
Docstrings explaining the underlined functions would be nice for developers but are not essential for API users, so it'd probably be enough to document the few non-underline functions (connect, disconnect, ...).

Sphinx perhaps is a bit of an overkill because as far as I know it is mainly meant for larger out-of-source documentation, which is not needed here.

from python-mpd2.

@supermihi it appears you are correct in that the MPD protocol docs are essentially the same as the CLI here. Making that obvious would certainly help newcomers figure out how to use this library more quickly!

OTOH, I think some user docs would still be useful here. Although Sphinx is very good at reading docstrings and making API docs, it can also be used for normal documentation - building HTML pages out of RST input.

@Mic92 I'll throw something together later today for you to take a look at.

from python-mpd2.

Sorry for the delay. The documentation is now in place. But command reference could be better. I will keep working on that.

from python-mpd2.

Hey guys,

I'm struggling with the database commands, specifically "search", "searchadd", "searchaddpl", "find" and "findadd". I don't even know exactly what libmpdclient function they're referring to, even less what arguments they might expect. So I guess documenting those would be a good idea.

Kind greetings and thanks for a very nice library!

P.S.: The repo you forked from doesn't seem to exist anymore, so a documentation seems to have become more important :)

P.P.S.: I don't know how it happened, but I thought this was a libmpdclient wrapper, so I was constantly looking at that documentation. Now I found what I think is the better place to look:

http://www.musicpd.org/doc/protocol/ch03s06.html

Forget what I said and merry Christmas!

from python-mpd2.

The reference is generated from the MPD protocol documentation. Now we have more lines of documentation than actual code.

from python-mpd2.