You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To generate developer documentation, we have to install epydoc.
But it is not specified to the readme file available in last rev (main and 2012.2).
Could you add a note to specify we have to install it?
I installed it before because I read the message on the list which specified that, but I supose some people hasn't had this message which was sent some months ago.
The text was updated successfully, but these errors were encountered:
Comment 1 by PZajda on 2012-06-08 19:06
Changes:
Changed title from "In the readme file, epydoc has disapeared" to "In the readme file, epydoc is not listed"
Comment 2 by jteh on 2012-06-09 04:59
Work on building code docs stalled because the current version of Epydoc doesn't work properly with Python 2.7, so it generates documentation with a lot of stuff (specifically comment docstrings) missing. I can add the Epydoc dependency, but it's misleading at best because it doesn't work as intended.
So could you make epydoc not required on devDocs target?
Because I tried to generate developers documentation without epydoc installed and scons terminated with error about epydoc missing.
Comment 4 by jteh (in reply to comment 2) on 2013-01-21 07:05
Replying to jteh:
Work on building code docs stalled because the current version of Epydoc doesn't work properly with Python 2.7, so it generates documentation with a lot of stuff (specifically comment docstrings) missing.
This is covered by bug 2585292, which includes a patch. Development of Epydoc seems to have stalled, so we'll have to maintain our own build. I've made a build including this patch.
e10bd0c adds Epydoc to the source readme and provides a link to this build.
Changes:
Milestone changed from None to 2013.1
State: closed
Reported by PZajda on 2012-06-08 19:05
Hi,
To generate developer documentation, we have to install epydoc.
But it is not specified to the readme file available in last rev (main and 2012.2).
Could you add a note to specify we have to install it?
I installed it before because I read the message on the list which specified that, but I supose some people hasn't had this message which was sent some months ago.
The text was updated successfully, but these errors were encountered: