"W. Trevor King" <[email protected]> writes:

> Out of curiosity, I just compiled the docs without numpydoc, and I'll
> leave the results here:
>   http://www.physics.drexel.edu/~wking/be-docs-without-numpydoc/
> for the next few days incase anyone else is curious.

Thanks very much for that.

I've applied this change to just remove the ‘numpydoc’ extension:

=== modified file 'doc/conf.py'
--- old/doc/conf.py     2011-02-23 15:56:18.000000000 +1100
+++ new/doc/conf.py     2011-02-23 16:04:52.000000000 +1100
@@ -27,7 +27,7 @@
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary',
               'sphinx.ext.doctest', 'sphinx.ext.coverage',
-              'numpydoc']
+              ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']


> All the user-directed stuff is fine.  Some of the API documentation
> isn't quite as nice.

You're right. I had assumed the dependency on the ‘numpydoc’ extension
was strict, but I'd be happy with those results.

When I try today, though, I get this error:

=====
$ make -C doc html
make: Entering directory `/tmp/buildd/bugs-everywhere-1.0.0/doc'
python generate-libbe-txt.py
sphinx-build -b html -d .build/doctrees   . .build/html
Running Sphinx v0.6.6
loading pickled environment... not found
building [html]: targets for 72 source files that are out of date
updating environment: 72 added, 0 changed, 0 removed
reading sources... [  1%] distributed_bugtracking
reading sources... [  2%] doc
reading sources... [  4%] email
reading sources... [  5%] hacking
reading sources... [  6%] http
reading sources... [  8%] index
reading sources... [  9%] install
reading sources... [ 11%] libbe/libbe

reST markup error:
/tmp/buildd/bugs-everywhere-1.0.0/libbe/__init__.py:docstring of
libbe:5: (SEVERE/4) Unexpected section title.

Examples
--------
make: *** [html] Error 1
make: Leaving directory `/tmp/buildd/bugs-everywhere-1.0.0/doc'
=====

-- 
 \      “It is the integrity of each individual human that is in final |
  `\        examination. On personal integrity hangs humanity's fate.” |
_o__)               —Richard Buckminster Fuller, _Critical Path_, 1981 |
Ben Finney

Attachment: pgpkLjXWufPOj.pgp
Description: PGP signature

_______________________________________________
Be-devel mailing list
[email protected]
http://void.printf.net/cgi-bin/mailman/listinfo/be-devel

Reply via email to