Hi Tim -
This is GREAT progress!
Some comments:
- Because of my experience w/ Python3Patterns book, I use / prefer to use
the hg trunk of sphinx; this seems to work (and showed a couple of error
messages below)
- 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.
- Using sphinx trunk, I got these error messages - (I was able to get
around this ultimately by modifying the Makefile):
- gluon/widget.py: tries to open the file VERSION, but it is not in
cwd;
- gluon/main.py: tries to get VERSION based on getcwd() - which
breaks when building from doc directory. the solution here is to run the
build from the main Makefile....
- File "web2py-sphinx/gluon/main.py", line 79, in <module>
web2py_version = open(os.path.join(web2py_path, 'VERSION'),
'r').read()
IOError: [Errno 2] No such file or directory:
'web2py-sphinx/doc/VERSION'
- to build from web2py-sphinx (to solve above) required a few
changes to the doc/Makefile (still need to check through it for
other-than-html areas)
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:
htmldocs:
DOCSDIR=$PWD/doc make -e -f doc/Makefile html
also probably want the html output do be more directly under docs... but
these are details...
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);
I have not yet tried generating pdf version - but it would also be nice to
create a link to download the pdf (for web hosting).
Thanks for all your significant efforts. This is a great start!
Regards,
- Yarko
On Wed, May 6, 2009 at 6:08 AM, Yarko Tymciurak <[email protected]> wrote:
> Hi Tim -
>
> The process you describe for contributing either risks overwriting
> web2py-sphinx changes, or assumes that both devel and web2py-sphinx branches
> are already in sync;
>
> After you once have a branch of web2py-sphinx, and a pull of devel, I think
> you will need to merge web2py-sphinx with devel before beginning to make
> changes destined for web2py-devel.
>
> That is, from your local web2py-sphinx, something like this:
>
> $ bzr merge #from saved lp: .... web2py-sphinx
> $ bzr merge devel #from local devel
> $ # resolve any conflicts!
> $ # make docstring changes to web2py-sphinx tree, then ... in case
> anyone else has made changes since:
> $ bzr merge
> $ bzr push
>
> Something like that, don't you think?
>
> - Yarko
>
>
> On Wed, May 6, 2009 at 1:48 AM, Tim Michelsen <[email protected]
> > wrote:
>
>>
>> Hi!
>>
>> > Note: The build setup may curretly not work correctly due to outstanding
>> > configuration isuues.
>> All config issues have been removed.
>>
>> > This will be adjusted during the course of the week.
>> I just pushed the latest changes to the repository:
>> https://code.launchpad.net/~web2py/web2py/web2py-sphinx<https://code.launchpad.net/%7Eweb2py/web2py/web2py-sphinx>
>>
>> You can see the problems we are still having at:
>>
>> http://bazaar.launchpad.net/%7Eweb2py/web2py/web2py-sphinx/annotate/head%3A/doc/sphinx-build.log
>>
>>
>> In future versions, we need to update the
>> web2py .bzrignore to exclude the logs.
>>
>> Just branch the files and follow instructions in the help file:
>>
>> http://bazaar.launchpad.net/%7Eweb2py/web2py/web2py-sphinx/annotate/head%3A/doc/source/docs_contrib.rst
>>
>> I hope that you are all able to built the docs! This come already very
>> close to a 1-stop-doc-shop.
>>
>> I will not do major chnages during the netx days. But I will be reading
>> list mails and respond of problems occur.
>>
>> Happy documenting,
>> Timmie
>>
>>
>> >>
>>
>
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"web2py Web Framework" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/web2py?hl=en
-~----------~----~----~----~------~----~------~--~---
