Re: How to? epydoc --top=README

2010-05-10 Thread Phlip
On May 10, 1:39 pm, Chris Rebert  wrote:

> Sphinx is in vogue right now:http://sphinx.pocoo.org/
>
> It's used for the official docs and its results are quite pretty.

The manager said to hold off on Sphinx until the next phase - then ran
off to get married or something.

But yet I persevere...
-- 
http://mail.python.org/mailman/listinfo/python-list


Re: How to? epydoc --top=README

2010-05-12 Thread Phlip
On May 10, 1:29 pm, Phlip  wrote:
> Pythonistas:
>
> I have a question to epydoc-devel, but it might be languishing:
>
> http://sourceforge.net/mailarchive/forum.php?thread_name=l2n860c114f1...
>
> How do you populate the index.html output with your (insanely clever)
> contents of your README file?
>
> When I try the obvious notations, such as --top=README or --
> top=README.html, I get:
>
> Warning: Identifier 'README' looks suspicious; using it anyway.
> Warning: Could not find top page 'README'; using module-tree.html
> instead
>
> And, yes, the README is included in the input list, and yes I get a
> script-README-module.html
>
> 8<--
>
> The question for the rest of Python-Land: Should I be using a better
> documentation extractor? (pydoc is too mundane so far.) Or should I be
> using a better forum for epydoc users questions?

Regardless of the advocacy, does anyone have an actual answer for
this?

>
> --
>   yes-I-know-topicality-ly-yrs
>   Phlip
>  http://c2.com/cgi/wiki?ZeekLand

-- 
http://mail.python.org/mailman/listinfo/python-list


[Epydoc-devel] How to? epydoc --top=README

2010-05-10 Thread Phlip
Pythonistas:

I have a question to epydoc-devel, but it might be languishing:

http://sourceforge.net/mailarchive/forum.php?thread_name=l2n860c114f1005061707k1ccf68cdz277a3d875b99fe04%40mail.gmail.com&forum_name=epydoc-devel

How do you populate the index.html output with your (insanely clever)
contents of your README file?

When I try the obvious notations, such as --top=README or --
top=README.html, I get:

Warning: Identifier 'README' looks suspicious; using it anyway.
Warning: Could not find top page 'README'; using module-tree.html
instead

And, yes, the README is included in the input list, and yes I get a
script-README-module.html

8<--

The question for the rest of Python-Land: Should I be using a better
documentation extractor? (pydoc is too mundane so far.) Or should I be
using a better forum for epydoc users questions?

--
  yes-I-know-topicality-ly-yrs
  Phlip
  http://c2.com/cgi/wiki?ZeekLand
-- 
http://mail.python.org/mailman/listinfo/python-list


Re: [Epydoc-devel] How to? epydoc --top=README

2010-05-10 Thread Chris Rebert
On Mon, May 10, 2010 at 1:29 PM, Phlip  wrote:
> Pythonistas:

> The question for the rest of Python-Land: Should I be using a better
> documentation extractor? (pydoc is too mundane so far.)

Sphinx is in vogue right now:
http://sphinx.pocoo.org/

It's used for the official docs and its results are quite pretty.

Cheers,
Chris
--
http://blog.rebertia.com
-- 
http://mail.python.org/mailman/listinfo/python-list