python API Power users hub

[Jee-Bee]

Is it true thaat the python api of the power users hub is out of date?
I was checking something and didn't find anything about sketcher WB, nor Part Design WB.

[yorik]

We have actually a problem here: The API wiki pages are created manually, and yes, indeed they are almost all out of sync with current version. On the other hand, we have the doxygen auto-generated pages at http://www.freecadweb.org/api which are more complete (although there is a long time I didn't update them either ) but are much less friendly to read...

We should really spend some effort in making better API docs somehow.. I wonder if there isn't some online service a la travis that could build the doxygen docs automatically and place them online for us...

[Jee-Bee]

would read the docs help
An example: https://python-sounddevice.readthedocs.io/en/0.3.12/

[PrzemoF]

[..]
We should really spend some effort in making better API docs somehow.. I wonder if there isn't some online service a la travis that could build the doxygen docs automatically and place them online for us...

github pages + travis-ci should be able to handle that [1].

[1] https://stackoverflow.com/questions/232 ... i#33125422

[yorik]

aah very good find! We could try to have a travis job to build the doc... Also the generated docs are very large (2Gb). Which is annoying to upload on our website. But for a github repo it might be much easier?

[PrzemoF]

I never tried it. I'm fighting hard with fedora.spec and copr - when I'm done I should have time to take a look at it.

[PrzemoF]

I did the setup, it's trivial, but I can't fully test it as my travis-ci account doesn't allow long builds anymore. Important step - set up a new repo in github for documentation.

[sgrogan]

aah very good find! We could try to have a travis job to build the doc... Also the generated docs are very large (2Gb). Which is annoying to upload on our website. But for a github repo it might be much easier?

See here for file size limits: https://help.github.com/articles/distri ... -binaries/
I assume the doc would be deployed as a release asset.

[PrzemoF]

I asked travis-ci for build time extension. If i get it I'll keep working on the tests, but the final setup will have to be executed by one of the core devs.

[dulouie]

Any progress for updated doc?
I've build my own doxygen doc with

Code: Select all

make DevDoc

but i need a clear python documentation.
How can i generate my own sphinx python doc?