Documentation about pifacecommon HOT 7 CLOSED

Had some time so knocked a "demo" of the way I see it..

The portal
http://piface-docs-demo.daffodil.uk.com/

The idea of some colourcoding is to identify which "API" i;m in, each in digitalio and a links to common..

eg as atrributes here

http://piface-docs-demo.daffodil.uk.com/pifacedigitalio/reference.html#pifacedigitalio.core.PiFaceDigital

from pifacecommon.

I've noted this down for when we do a review. Thanks.

from pifacecommon.

Hey GUYS!!!

Aint heard Nothing..

Can we make some moves on this..

I dont mind and kinda want to

• hosting it..
• and baby sitting it
• cos I need it..

http://piface-docs-demo.daffodil.uk.com/
and production version by monday is
http://piface.daffodil.uk.com/

U can send and DNS entry there if u want...

How it works,,
Its a piface@ sheel account..
and a cron job that runs every hour

• snag is the compile must be done twice for xref..
• the compiled sphinx is direct to web.. if it succeeds

The only snag is I need a few pull requests into each "repos"..
for adding comments and alike to code...

So What I would prefer if a "docs" branch in each repos,
with the interntion of merging than into "master" and code..

each build will have travis and others to validate the pep8 style and compile files..

Hope to hear soon ;-))

pedro

from pifacecommon.

Reviving this bug..

and working on a cunning (am farmers son from wales and know what a fox is like) plan to automate the whole docs, all in one go and interlinked on one website..

Atmo its a mish mash of stuff.. when it fact all that needs to happen is any code change fires of a compile.. but in out case.. all the docs need to be compiled..
eg a new "function" or class.. a change to a method signature.. interlinking together to a function that does not exist etc...

from pifacecommon.

Hey! So sorry I didn't get back to you on this. Automating the docs with Sphinx is the correct way of doing things but we've already using a free service called Read The Docs to do this:

• http://pifacecommon.readthedocs.org/en/latest/
• http://pifacedigitalio.readthedocs.org/en/latest/

This is fast becoming the standard documentation platform for open source projects. It's searchable and follows a consistent (mobile accessible) theme.

from pifacecommon.

Hi Tom..

Am familiar with ReadTheDocs, doxygen, sphinx et all (was 50 last week, having started on a zxspectrum ;-)

The snag with readthedocs, is that it dont interlink docs, unless u can run the compile twice ..

So I'll get this site up and running tonite.. so i can see what i mean... my target would be a subdomain eg docs.piface.org

from pifacecommon.

Check this other site for flightgear on doxygen for inspiration
http://api-docs.freeflightsim.org/

from pifacecommon.