python API Power users hub

Discussions about the wiki documentation of FreeCAD and its translation.
Jee-Bee
Posts: 1992
Joined: Tue Jun 16, 2015 10:32 am
Location: Netherlands

python API Power users hub

Postby Jee-Bee » Thu Oct 25, 2018 7:44 pm

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.
User avatar
yorik
Site Admin
Posts: 11712
Joined: Tue Feb 17, 2009 9:16 pm
Location: São Paulo, Brazil
Contact:

Re: python API Power users hub

Postby yorik » Fri Oct 26, 2018 2:09 pm

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 :oops: ) 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
Posts: 1992
Joined: Tue Jun 16, 2015 10:32 am
Location: Netherlands

Re: python API Power users hub

Postby Jee-Bee » Fri Oct 26, 2018 2:42 pm

would read the docs help
An example: https://python-sounddevice.readthedocs.io/en/0.3.12/
User avatar
PrzemoF
Posts: 2757
Joined: Fri Jul 25, 2014 4:52 pm
Contact:

Re: python API Power users hub

Postby PrzemoF » Fri Oct 26, 2018 3:07 pm

yorik wrote:
Fri Oct 26, 2018 2:09 pm
[..]
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
User avatar
yorik
Site Admin
Posts: 11712
Joined: Tue Feb 17, 2009 9:16 pm
Location: São Paulo, Brazil
Contact:

Re: python API Power users hub

Postby yorik » Sat Oct 27, 2018 7:43 pm

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?
User avatar
PrzemoF
Posts: 2757
Joined: Fri Jul 25, 2014 4:52 pm
Contact:

Re: python API Power users hub

Postby PrzemoF » Mon Oct 29, 2018 8:29 pm

I never tried it. I'm fighting hard with fedora.spec and copr :evil: - when I'm done I should have time to take a look at it.
User avatar
PrzemoF
Posts: 2757
Joined: Fri Jul 25, 2014 4:52 pm
Contact:

Re: python API Power users hub

Postby PrzemoF » Thu Nov 01, 2018 7:22 pm

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.
User avatar
sgrogan
Posts: 5651
Joined: Wed Oct 22, 2014 5:02 pm

Re: python API Power users hub

Postby sgrogan » Thu Nov 01, 2018 8:28 pm

yorik wrote:
Sat Oct 27, 2018 7:43 pm
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.
User avatar
PrzemoF
Posts: 2757
Joined: Fri Jul 25, 2014 4:52 pm
Contact:

Re: python API Power users hub

Postby PrzemoF » Fri Nov 02, 2018 10:00 am

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.
User avatar
dulouie
Posts: 76
Joined: Tue Oct 03, 2017 4:14 pm

Re: python API Power users hub

Postby dulouie » Thu Feb 07, 2019 6:18 pm

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?