Hi,
autodoc only works for Python.
--
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
You have to use :py:func:`file` because `file` is documented as a
function and not a class.
--
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
You can create a custom theme and/or put a CSS file to _static to
modify the HTML output. Themes can inherit from each other so you
don't have to reinvent everything.
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group, send email
There is no reason to update the makefile unless you want to use a new
builder. In any case you can simply use sphinx-quickstart and copy the
makefile, as long as you choose the same options for source and build
directories.
--
You received this message because you are subscribed to the Google
If you want to be able to document software written in a specific
language e.g. Python you need to implement a new Domain [1]. Use the
existing ones as an example, the restructured text and javascript
domains are relatively easy to understand. You will probably still end
up with a lot of questions
There is no markup for parameters.
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to
sphinx-dev+unsubscr...@googlegroups.com.
For more
Thank you for your help. I will look into the issues you reported.
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to
Sphinx detects the changes only by the timestamps on the files, if you
move the entire source tree the timestamp on every file changes and
Sphinx rebuilds the entire documentation.
Currently there is no easy way around this. A possible solution would be
to update the timestamps in the cache after
Georg Brandl just made aware of the fact that I missed to show how to
install nose which is used for the test suite. In order to do that
simply use execute:
(env)sphinx# easy_install http://bitbucket.org/jpellerin/nose3/get/tip.zip
Obviously you should do that before executing the tests.
I'm
The only similarity is the name and may be the similar logo as you
pointed out.
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to
:
(env)sphinx# easy_install docutils pygments jinja2
install_dir /home/dasich/Projects/sphinx/env/lib64/python3.1/site-packages/
Searching for docutils
Reading http://pypi.python.org/simple/docutils/
Reading http://docutils.sourceforge.net/
Best match: docutils 0.7
Downloading
http://pypi.python.org
I'm having trouble using the intersphinx extension. I added python and sphinx
itself in conf.py:
intersphinx_mapping = {
'python': ('http://docs.python.org/', None),
'sphinx': ('http://sphinx.pocoo.org', None)
}
Did you also add 'sphinx.extensions.intersphinx' to the `extensions`
I've changed the URL in my fork and send a pull request to Georg. The
URL will be changed in trunk as soon as he pulls the changeset.
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group, send email to sphinx-...@googlegroups.com.
I don't see a problem with changing the behavior as you proposed in
general but it breaks backwards compatibility and the current behavior
is perfectly documented.
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group, send email to
In order to use syntax highlighting for those languages you would have
to implement a lexer for pygments for those languages. That's not a very
difficult task although how difficult it gets depends on the language
you are implementing.
--
You received this message because you are subscribed to
1.0b2 is a beta version and a lot has changed so bugs are to be
expected. It would be nice if you could provide the document to
reproduce the error, this way we can fix it.
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group, send
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
This mailinglist is for Sphinx the documentation you find at
http://sphinx.pocoo.org/
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to
Yesterday the changes were reverted by Georg
http://bitbucket.org/birkenfeld/sphinx/changeset/2f0924a705b2.
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this
Autodoc simply imports the module to work with it, so it has to be in
the path. You can either define $PYTHONPATH or modify sys.path in the
conf.py accordingly. I suppose the latter is the more convenient
method.
--
You received this message because you are subscribed to the Google Groups
started
porting Sphinx, if you want to follow my progress you can do so by following
the bitbucket repo http://bitbucket.org/DasIch/sphinx-py3k or me. For those
of you who want to see the interesting parts right away and don't want to look
at every commit you can read my blog http
autodoc is a sphinx extension and it doesn't generate restructured text so I
suppose that nobody has really given it some thought.
signature.asc
Description: This is a digitally signed message part.
I think that should be implemented as part of intersphinx. I spoke about it a
while ago with Georg but as far as I remember he didn't see the need for it
but if enough people ask and someone provides an implementation I don't think
he will say no to it.
So the question is who wants to do it?
and
especially FOSS projects. I hope to be able to get faster and more
involvement
in FOSS projects with the knowledge gained during the summer.
Contact
---
:E-Mail: dasdas...@gmail.com
:IRC: DasIch in irc://irc.freenode.net:6667
:Twitter: `...@dasich http://twitter.com/DasIch/`_
:Phone: Will be given
techniques.
I think of GSoC_ as a way to learn management and communication in software
and
especially FOSS projects. I hope to be able to get faster and more involvement
in FOSS projects with the knowledge gained during the summer.
Contact
---
:E-Mail: dasdas...@gmail.com
:IRC: DasIch in irc
Sphinx itself does not run under 3.x, that doesn't mean you can't document 3.x
code with it, though.
Hopefully one of the GSOC students (may be me?) will port Sphinx to 3.x
-- DasIch
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post
28 matches
Mail list logo
