Markmin looks pretty sweet, tiny and fast!
http://www.web2py.com/examples/static/markmin.html
C.
On Jul 14, 12:36 pm, mdipierro mdipie...@cs.depaul.edu wrote:
We had an attempt to use rest and sphinx but now that despitce help
form many people we never managed to make it work decently because
It depends. If the docstrings are well written they can be useful to
both.
On 13 Lug, 21:52, weheh richard_gor...@verizon.net wrote:
Massimo, isn't epydocs more geared to the web2py developer than the
user? I agree, embedding the user documentation into the code is
desireable (write once,
Then, let it be epydocs (thanks ra3don). Let's get concensus on a good
template for a man-page docstring and get on with it!
I'm going to suggest that major headings include:
Name of command
Synopsys
Description
Parameters and their meanings
Return values
Examples
Links (to external
We had an attempt to use rest and sphinx but now that despitce help
form many people we never managed to make it work decently because of
third party dependencies. I'd rather use something that only requires
web2py to be parsed. MARKMIN was designed in such a way to allow this
def example():
Massimo, again, I'm all in favor of simplicity, especially if it means
less of your time involved. The convention for a man page and the
markup language need to be documented as the first step in making the
reference, and preferably, should be a part of the reference
itself.Obviously, this forum
Yeah i noticed its a little hard to comprehend sometime if you have no
idea whats going on. Some entries don't have descriptions at all, just
leaves you scratching your head.
On Jul 12, 10:25 pm, weheh richard_gor...@verizon.net wrote:
@MDP: No reason for GAE in particular other than it's free
That is the problem.
for people who seriously want to help. Setting up another wiki is not
help. Instead, adopt a web2py file, add docstrings to all functions.
On 13 Lug, 16:38, ra3don ra3do...@gmail.com wrote:
Yeah i noticed its a little hard to comprehend sometime if you have no
idea whats
I would look into the most common files
globals.py
html.py
sql.py
only stuff defined in these files is exposed to users. The rest is all
internals.
On 13 Lug, 17:31, Bruno Rocha rochacbr...@gmail.com wrote:
Massimo, could you provide a list with reference to the files that need docs?
any way
Massimo, isn't epydocs more geared to the web2py developer than the
user? I agree, embedding the user documentation into the code is
desireable (write once, serve many). But, users and developers have
differing needs and comprehension levels. If the output of epydocs can
be optimized to also
Massimo, I couldn't agree more. This is not a tech issue. It's an
issue of resolve by the community to help build doc. I do not wish to
make more work for you. I may be naive, but I hope for the opposite --
to distribute the doc burden more on the community.
The existing doc v2 is a major
PHP manual is great, I always use, the information are easy to find, and
connections with related subjects are simple, one advantage is that it was
written in a way that allows various applications, badges, widgets etc using
your content
I think that information in the PHP manual is organized
Look what i am talking about, in action -
http://www.pyforum.org/pyforum/default/view_topic/507
2010/7/12 Bruno Rocha rochacbr...@gmail.com
PHP manual is great, I always use, the information are easy to find, and
connections with related subjects are simple, one advantage is that it was
Yes, I see it, thanks. I really do not like this format for a
reference manual. Just a personal preference. Sorry.
I do like the PHP index and cross linking, and I do think there are
some good ideas there, but I think a Reference Manual should be less
of a forum and more documentation oriented.
On Jul 12, 2010, at 9:20 AM, weheh wrote:
Yes, I see it, thanks. I really do not like this format for a
reference manual. Just a personal preference. Sorry.
I do like the PHP index and cross linking, and I do think there are
some good ideas there, but I think a Reference Manual should be
Jonathan, thanks for weighing in. I'm with you that the new web2py
wiki should be the platform. Preferably on GAE. Massimo, will it work?
Also, it makes sense to me that this be addressable under
www.web2py.com/reference.
Why GAE? Is there a performance issue with the current book?
On 12 Lug, 12:53, weheh richard_gor...@verizon.net wrote:
Jonathan, thanks for weighing in. I'm with you that the new web2py
wiki should be the platform. Preferably on GAE. Massimo, will it work?
Also, it makes sense to me that this
On Jul 12, 2010, at 12:33 PM, mdipierro wrote:
Why GAE? Is there a performance issue with the current book?
For my part, only because it'd be a prominent demonstration of web2py on GAE.
Other than that, it doesn't matter.
On 12 Lug, 12:53, weheh richard_gor...@verizon.net wrote:
Jonathan,
One quick question. What would be the difference between this and say,
the epydoc http://web2py.com/examples/static/epydoc/index.html, other
than this having wiki capabilities. Am i missing something obvious?
On Jul 12, 2:48 pm, Jonathan Lundell jlund...@pobox.com wrote:
On Jul 12, 2010, at
@MDP: No reason for GAE in particular other than it's free initially
and because it's a showcase. Any server is good, as long as the url is
something like web2py.com/reference. There is no performance issue
with the current doc.
@ra3don: Epydocs have very little verbiage and is indecipherable to
I´m intrested in helping setting up a reference manual, I have never
done anthing like this before so help is needed, I´m neither so deep
into web2py yet that I know where to start.
I guess we need to start and agree on three things:
a) type of manual, wiki or php forum style. I think wiki
One other thing we might consider, as Kenneth said 5 million monthly
page views, we could cut that by providing a download version of the
reference manual, so that us that frequent it aren't racking up on the
page views.
On Jul 11, 8:39 am, Kenneth kenneth.t.lundst...@gmail.com wrote:
I´m
What about having the reference manual divided in 9 apps.
The limit is by app, and a single account can create 9 apps.
One chapter per app.
Sent from my iPhone
On 11/07/2010, at 18:56, ra3don ra3do...@gmail.com wrote:
One other thing we might consider, as Kenneth said 5 million monthly
page
Massimo, do you think 5M pageviews would be exceeded in any month for
the time being?
ra3don: I like your idea of a download version. If we pack all into
a .w2p then the downloadable reference manual would be implemented.
Then you could install it on your local machine and access it later,
even
This issue issue comes up regularly and my answer does not change.
I very much welcome a community effort to have a better documentation.
It was attempted many times before and many times it has failed. It
failed because people think it is a technological issue (which wiki do
we use?) but it is
Why not use cube2py as the wiki?
http://groups.google.com/group/web2py/browse_thread/thread/5b8481c48478eed9/29a01260e7d38618#29a01260e7d38618
You can but set
plugin_wiki_level=1 to disable embedded widgets for security
On 10 Lug, 10:28, weheh richard_gor...@verizon.net wrote:
Why not use cube2py as the
wiki?http://groups.google.com/group/web2py/browse_thread/thread/5b8481c484...
How shall we do the hosting? Who should administer the site? What to
call it? Shouldn't it be under web2py.com/reference_manual or some
such?
On Jul 10, 12:26 pm, mdipierro mdipie...@cs.depaul.edu wrote:
You can but set
plugin_wiki_level=1 to disable embedded widgets for security
On 10 Lug,
http://www.pyforum.org/ Pyforum, could be a start!
with little changes and putting it running on Google App Engine.
2010/7/10 weheh richard_gor...@verizon.net:
How shall we do the hosting? Who should administer the site? What to
call it? Shouldn't it be under web2py.com/reference_manual or
No, I don't think Pyforum is the answer. I am calling for a reference
manual. The existing documentation is slanted a little more towards a
tutorial form. I'm looking for a very dense, concise, and heavily
cross-indexed document/database of web2py statements and their
attributes, along with
can cube2py run in google app Engine??
if yes: why not run it on GAE to start from??
regards!
Pepe
On Jul 10, 2:01 pm, weheh richard_gor...@verizon.net wrote:
No, I don't think Pyforum is the answer. I am calling for a reference
manual. The existing documentation is slanted a little more
Pepe, that's exactly what I was thinking. I haven't done anything like
this myself, so I have no experience. However, my assumption is that
should the number of hits get large enough, then whoever sets up the
app will have to start paying Google for bandwidth, etc. I have no
idea how expensive
I like this idea alot, it would be a valuable resource for a beginner
(like me). I think its important that it be wiki-style so that we can
all come in and add our example useages to the statements, helpers,
etc. (like weheh mentioned) so we get a feel for how to use it if
we're stuck.
On Jul 9,
I like php manual style, where at the bottom are user contributions
33 matches
Mail list logo
