Hi!
I try to create a documentation for my p-group cohomology spkg, using
sphinx. Problem: I am completely lost.
Even after looking into the documentation for sphinx and trying to
learn from the .rst files in the sage documentation, I can not figure
out how it could work.
How can I tell sphinx where the modules-to-be-documented are?
Looking at the sage documentation, I see that the names of the python
or cython files are given without their extension, the path starting
with 'sage/'. I guess that the current SAGE_ROOT+'/devel' branch is in
the path, so that the files are found.
Therefore, I added the 'src'-folder of my package to sys.path, and the
file index.rst then contains lines such as
pGroupCohomology/cohomology
Also, I was adding the python code at the end of sage/doc/common/
conf.py to my spkg's documentation/conf.py
pGroupCohomology is a sub-folder in the src-folder of my package (and
this src-folder is in the path). It contains cohomology.pyx. But when
I run 'sphinx-build html', it is said that "toctree references unknown
document".
I am sorry to ask here, but in the documentation for sphinx I can't
see how to solve my problem. Could you please tell me how to turn my
doc-strings into a documentation?
Best regards
Simon
--~--~---------~--~----~------------~-------~--~----~
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/sage-support
URLs: http://www.sagemath.org
-~----------~----~----~----~------~----~------~--~---
