Developers reference

[willianpaixao]

Pagekite should have documentation for developers.
The library and classes should be documented.
I thought to use Doxygen (http://www.stack.nl/~dimitri/doxygen/).

[pagekite]

Agreed, but I would probably stick with native Python documentation tools (pydoc etc.).

Consider this a TODO. :-)

[willianpaixao]

I agree. pydoc is better for this use.
The main reason to use Doxygen is the several output formats.

If you take a look the features of Doxygen, you can change your mind about pydoc.

What do you think?

[dokterbob]

Some developer referene (or at the very least more comments in the source code) would be of great help indeed. I am considering integrating PageKite into the Django development server, but spend more than an hour trying to find the hooks I need.

[pagekite]

Just to clarify our position on this: we absolutely agree, but we want to finish refactoring and cleaning the code up before we spend time on documenting it.

We have been breaking the monolithic pagekite.py into submodules a little bit at a time, while trying to keep things from breaking. Our test coverage is somewhat lacking, so this takes a while. Documenting things while everything is still moving around doesn't feel like an effective use of time.

For now, people who want to work with the code and integrate with other systems should probably chat with us on #pagekite on irc.freenode.net.

[willianpaixao]

Ok!
I use Pakekite a lot and I want to help this amazing software to improve.
I look some little bugs when pagekite is under a proxy in Linux (I don't know if affect other os). Like if you set the proxy variables in the new syntax (Acquire::http etc) pagekite does not work! But I will send a complete bug report and probably I will fix it myself.

And I already added your channel in my IRC client.

Thanks!

[pagekite]

I've created a draft DEV-HOWTO.md, located here: https://github.com/pagekite/PyPagekite/blob/main/doc/DEV-HOWTO.md

It would be interesting to hear which questions you guys would like answered in that doc.