Hi,
I'm trying to use the Sphinx autodoc extension to document a
quickstarted Turbogears 1.0.7 project and having lots of problems. I
think I've got a basic conceptual misunderstanding. Any thoughts
appreciated.
This is where I got to:
Run sphinx-quickstart from the root of my TG project in ~/src/studio
Specified ~/src/studio/docs as the environment
Ran make html to produce a scaffold in docs/buildhtml tree. Works
fine.
Then I get stuck.
Anything I add to index.rst or other rst files gives the error -
"UnicodeError: Unable to decode input data. ". I can't see anything
weird with my docstrings.
Then even if I delete the new lines and/or files I can no longer
build. make clean doesn't help. I have to wipe the whole doctree.
That stumps me!
I'd like to set up Sphinx to reference my classes in ~/src/studio/
studio/model.py
I tried adding adding these modifications
~/src/studio/docs/sources/modules/index.rst
Modules
=========
.. toctree::
:maxdepth: 2
modules/model
~/src/studio/docs/sources/modules/model.rsrt
:mod:`studio.model`
=======================
.. automodule:: studio.model
Classes
--------
.. autoclass:: Visit
:show-inheritance:
:members:
:inherited-members:
:undoc-members:
All my docstrings are plaintext so I'm unclear what the unicode error
is and there's no clue as to which file is causing the problem.
If I try to to use the following video/code combo as a guide - can't
find any other tutorials for beginners - I get even more confused.
http://showmedo.com/videos/video?name=2910020&fromSeriesID=291
http://pythontutorials.googlecode.com/svn/tutorials/barbershop/
In conf.py , the tutorial author has modified sys.path as such, I'm
assuming to reference his codebase, but the autogenerated comment in
conf.py implies this line is only to find extensions...
sys.path.append(os.path.abspath(os.path.dirname(__file__)+'/../../'))
Thanks in advance for any clarification
.M.
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en
-~----------~----~----~----~------~----~------~--~---
