When I use sphinx to generate information automatically from
docstrings I have never gotten docstrings data to be included in the
pdf document. The pdf file contains an index of all the modules but
doesn't include the docstring info from all the module, class and
functions that have docstrings.  Interestingly the html documentation
that is produced contains it all.  Pdf just has the index and blank
documentation pages.
I have a very minimal index file.  I'm really trying to generate all
the information I want from docstrings and not
from external sources.

Also, I'm not all that interested in html documentation because many
times I'm programming I don't have a browser up but am working from
the Linux command line in eclipse or vi.  I want and need printed
documentation.  I'm not a big believer that the browser has replaced
the printed page.

Any help anyone can give me would be appreciated. I'm trying to
convert from epydoc to sphinx but sphinx while powerful is extremely
arcane and more geared to manual written documentation and web pages.
However, I can see advantages going with this route if I can get
useful pdf documentation.
---------------------------------------------------------------------------------------------------------------------------
Here is my index.rst:

.. nrtGPM documentation master file, created by
   sphinx-quickstart on Sat Mar 19 04:31:26 2011.
   You can adapt this file completely to your liking, but it should at
least
   contain the root `toctree` directive.

Welcome to nrtGPM's documentation!
==================================

Contents:

.. toctree::
   :maxdepth: 2

.. automodule:: activateGPMprocess
   :members:

.. autoclass:: ContextVars
   :members:

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to