Yes - the wiki is the live contributions place. Once pages / sections are stable, we export to a Sphinx workspace (we could have community contribution on that too - much like Bruce Eckel has done).
Sphinx is a "layer" on top of reST; so if Wiki uses reST, then we will need from a reST wiki is a way to save the pages by name, and then create spinx TOC and indexes (including adding index keys where they are needed), cross references, etc. Sphinx html pages are static - our web2py evloving community book can start in the wiki, then progress to static pages. This is exactly what this page is (for example): <http://docs.python.org/tutorial/interpreter.html> http://docs.python.org/tutorial/interpreter.html Of course we will put our own look on it, just like sphinx ( http://sphinx.pocoo.org/) <http://sphinx.pocoo.org/>, or Django ( http://docs.djangoproject.com/en/dev/)<http://docs.djangoproject.com/en/dev/>, or Enthought's documents have (http://docs.scipy.org/doc/)<http://docs.scipy.org/doc/> You can see the sources (and how the "book production from wiki pages" would look) to Bruce Eckel's book project: "Python 3 Patterns and Idioms" here: http://bitbucket.org/BruceEckel/python-3-patterns-idioms/src/ We decided to include html output and pdf for those who would contribute to that book, but would not want to build their own book, rather just contribute the reST text updates. Look in particular at the "src" directory - There's a Makefile, and a "conf.py" --- everything else is reST sources; I see this as starting from "scraping" the reST sources from the wiki (a wiki page becoming a *.rst file), and adding indexes, todo markers, and so on... Sphinx builds on reST: http://sphinx.pocoo.org/rest.html#explicit-markup and adds directives that are "book" related: http://sphinx.pocoo.org/markup/index.html It should be clear that the wiki would be a fist contribution and revision space; the sphinx place would be the place to make final revisions, organize and relate things, add cross references and so on. Oh - Joy! We're going to have a community generated book project web2py!!!! I'm really happy. :-) Yarko On Thu, Feb 26, 2009 at 10:24 PM, mdipierro <mdipie...@cs.depaul.edu> wrote: > > Yarko. OK. We will use Sphinx. But I need to understand this first. > Sphinx provides the capabilities of rendering text into HTML, etc. for > documentation purposes. We still need a wiki so that people can > collaborate in editing such documents. Am I missing something? > > If we want to eat our own food we can use https://mdp.cti.depaul.edu/wiki > and we can integrate it with Sphinx. Pros, Cons. > Anybody willing to help in this integration? > > Massimo > > > On Feb 26, 7:26 pm, Yarko Tymciurak <yark...@gmail.com> wrote: > > Massimo, Massimo, Massimo - > > > > I missed this important discussion and topic: > > > > YOU of all people (*smile*) MUST use restructured text, and go > > towards sphinx. > > > > We have been down this road before, and Greg (in this thread) points > > it out again; Bruce Eckel is writing his book "Python 3 Patterns and > > Idioms" in sphinx (and I've helped w/ some of the setup, etc. which is > > why I am so convinced). > > > > Like the python.org internal moin-moin sites do, I suggest you work to > > get restructured text as the default language of the wiki, and allow / > > ignore the few sphinx extensions to restructured text. > > > > For existing alter ego, make a header at the top of a post which will > > switch processing to markdown, > > > > e.g. > > > > [!markdown] > > > > or some such thing which you eat before rendering. > > > > Sphinx generates PDF, and latex > > > > You will be able to add your own chapters to this mix (although I > > would recommend doing it all in sphinx) > > > > The final (non-editable) item will be available as HTML (something > > SORELY missed for web2py now!), and - as others have noted - the > > indexing is there. > > > > As a longer term project, we could try to make a "live sphinx" --- > > that is a full sphinx wiki, but there will be some challenges. > > > > Please, please, please - run restructured text for the public > > contributions, and we can dump the source, and add sphinx indexing, > > etc. to make a final product - something that can be done > > periodically, and maintainable - and you will have latex from it too. > > > > Please! > > > > (Thank you!) > > Yarko > > > > On Feb 25, 10:51 am, mdipierro <mdipie...@cs.depaul.edu> wrote: > > > > > I am not sure Shinx is the same as track. > > > > > I think there are different issues...tracdoes lot of stuff but we > already have launchpad. I think we only > > > need a wiki. > > > > > I do not thinktracis our tool. > > > > > is there any wiki out there that can automatically generate a TEX + > > > PDF document? > > > > > massimo > > > > > On Feb 25, 10:10 am, ctalley <ctal...@caci.com> wrote: > > > > > > I'm sure all the tools mentioned (Trac, web2py, Sphinx) have certain > > > > advantages and disadvantages, and I don't claim to know what they all > > > > are, but a strong argument for Sphinx is that it is what > > > > docs.python.org uses. Of course the downside might be the learning > > > > curve if nobody's ever used it. > > > > > > On Feb 25, 10:00 am, Fran <francisb...@googlemail.com> wrote: > > > > > > > On Feb 25, 2:51 pm, Paul Eden <benchl...@gmail.com> wrote: > > > > > > > > - Doesn'tDjangouseTrac? > > > > > > > Yes:http://code.djangoproject.com/ > > > > > > > > using the framework shows a lot of confidence in it > > > > > > > If the Wiki could have versioning added, that would take away the > > > > > major constraint to it. > > > > > Not sure how hard that is... > > > > > > > F > > > --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
