I've just started using Sphinx to document my first real Python
project and am loving it so far.
I'm having a problem with autodoc though: I haven't managed to get
parameter types to show up in the parameter list of function/methods
in HTML builds. I haven't found anything either in Sphinx'
We are testing out using Sphinx for a cross-platform app, and it looks
ok on both Windows and Linux, apart from one wrinkle. The search
function simply doesn't do anything on Linux. No error messages, just
nothing. The same doc set works perfectly on windows xp and 7.
I'm running CentOS 5 with KDE
Hello, is there a way to reuse hyperlinks in the sphinx system? i.e -
avoid copy-pasting urls from file to file?
for example I would like to have external links entered like so:
`some link text name_for_url`_
and in some other file:
.. _name_for_url: http://example.com/
Thanks.
Evgeny.
--
On 06/22/2010 10:38 AM, Pedro Ferreira wrote:
Hello,
I am trying to use automodule on one of my project's modules, and i'm
getting the following error message:
{{{
reading sources... [100%] test
/home/pferreir/indico/cds-indico/doc/api/source/test.rst:4: (WARNING/
2) autodoc can't import/find
On 06/24/2010 08:45 PM, Evgeny wrote:
Hello, is there a way to reuse hyperlinks in the sphinx system? i.e -
avoid copy-pasting urls from file to file?
for example I would like to have external links entered like so:
`some link textname_for_url`_
and in some other file:
.. _name_for_url:
Hi folks,
is it possible to insert complete autodoc from all contents
(subpackages and all) of a package.
For example I have a project that has an empty file __init__.py, a
bunch of other .py files and directories that contain other
__init__.py and so on.
Is there a way to extract all
Hello, I'm trying to use sphinx for our project - askbot QA forum.
Would really like to keep all developer documentation within the
source code files, because I'm afraid that documentation in the
external files is more likely to get out of sync with the real code.
Is anyone doing this? Are there
You could use the autodoc extension, this way you can use the docstrings
in the documentation.
If you look at Sphinx itself you will see that the developer
documentation consists only of the docstrings, the only written
documentation is the one you can find on http://sphinx.pocoo.org.
So I guess
Sphinx is intended to be used as a tool for handwritten documentation so
you probably won't find a satisfying solution for this unless you switch
to something like pydoc.
Nevertheless there is the autosummary
http://sphinx.pocoo.org/ext/autosummary.html extension which is
supposed to more or less
There is no good solution for it in 0.x but 1.0 has an extension called
extlinks http://sphinx.pocoo.org/latest/ext/extlinks.html which solves
this problem.
Currently 1.0 is still at the beta stage so if you are not comfortable
using 1.0b2 you will have to wait for the final release to use this
10 matches
Mail list logo