On Wed, May 6, 2009 at 8:25 AM, Timmie <timmichel...@gmx-topmail.de> wrote:
> > > - To find what docstring needs work, look at the docs for things like: > > System Message: ERROR/3 (web2py-sphinx/gluon/sql.py:docstring of > gluon.sql, > > line 6) > > Unexpected indentation. > I know. These are also saved in the sphinx log file in the doc > directory. I mentioned how this looks for people who might take an early look at the sphinx docs. > > Running the sphinx build from the MAIN makefile - then all directories > are > > as needed - seem to work. I'll go through the rest of the makefile - > but > > basically, the make command for htmldocs (which can go in the main > Makefile) > > will look somthing like: > Yesterday, I run in the same problem, I guess. > > Therefore I wrote in docs?contrib.rst: > > #. built with custom make files for web2py => **Note: we could create > a > cross-platform python script for this!** > > #. unix-like: ``sh doc/make-doc_html.sh`` > #. windows: ``doc\make-doc_html.bat`` > > Due to the special manner of the *web2py* import mechanism it > requires that > the doc is built from the *web2py* root directory. I see - I missed this - you have hardcoded a sphinx command... I've fixed the makefile so that this will work from the main web2py makefile, for any target in the sphinx makefile. > > also probably want the html output do be more directly under docs... but > > these are details... > No, I defined a output path specified by Massimo. > He probably wants to put these in the same folder as the epydoc in the > examples app. Ah - I see this in your hardcoded sphinx command; well... we (community) need to talk about this. A developer, working from source, sees a "doc" directory and looks there, I want them to see a PDF file here, and an html directory .... It should be obvious and easy to get to the manual --- even before running web2py. > > > I seem to get the warnings like you get from the wiki, so we must be in > > sync at this point (though I wonder if the generated html is the same); > We could check whether this is systematic and edit the files by a > script. To do this once, we could do this manually or by script - as you like. The wiki in raw form does not belong as part of the manual (it can be used in the beginning). Again - this is the difference between a wiki (where anyone can add, contribute) and a manual. In my mind the priorities are [1] docstrings, [2] Alterego, [3] wiki. The wiki is really more important to show how to do it. I expect ongoing we will take specific pages or sections of the wiki as a starting draft component to include in the manual. We do not want to dump wiki at all times into the manual. Do you think we should even bother including the wiki as a spinx doc, or is a link to the current wiki sufficient? - Yarko --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "web2py Web Framework" group. To post to this group, send email to web2py@googlegroups.com To unsubscribe from this group, send email to web2py+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/web2py?hl=en -~----------~----~----~----~------~----~------~--~---
