Detailed documentation and plug-in API

Registered by Chris Ortner on 2008-03-25

Inside the doc folder there are already empty HTML files for certain topics. It would be great to fill them with content concerning usage of P1tr and how things work. Additionally a plug-in API should be created to ease others the writing of plug-ins.

To create a plug-in API the docstring of the functions which get accessed by plug-ins should be complete.

Blueprint information

Status:
Started
Approver:
Chris Ortner
Priority:
Low
Drafter:
None
Direction:
Needs approval
Assignee:
Chris Ortner
Definition:
Approved
Series goal:
Accepted for 0.1
Implementation:
Good progress
Milestone target:
milestone icon rc
Started by
Chris Ortner on 2008-03-29

Related branches

Sprints

Whiteboard

Wrote many docstrings and created API docs using pydoctor. Done in revision 40.

TODO: Docs about usage, installation etc.

(?)

Work Items

Dependency tree

* Blueprints in grey have been implemented.

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.