[sphinx-dev] Sphinx 1.0b2 autodoc: parameter types not showing up in info field lists
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' documentation nor the internet regarding this problem. From what I've read, with this: class data_source_local(data_source): Extends :class:`data_source` to use a local CSV file. def __init__(self, csv_path): Uses local CSV file. :param csv_path: Path to CSV file :type csv_path: string I should be getting this: class customreports.data_source_local(csv_path)¶ Extends data_source to use a local CSV file. Uses local CSV file. Parameters: * csv_path – (string) Path to CSV file But what I get in the parameter list is this (note the missing string type): * csv_path – Path to CSV file Have I overlooked a configuration option? http://sphinx.pocoo.org/markup/desc.html#info-field-lists doesn't mention any, and this is the only page I found that refers to the issue. I just tried a manual attempt, and even copying the example 'format_exception' function from the previous link results in a typeless parameter list. -- 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
[sphinx-dev] Search Function Firefox on Linux (Centos+KDE)
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 3.5.4 and Konqueror 3.5.4 -- 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
[sphinx-dev] A way to reuse hyperlinks?
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. -- 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Namespace packages
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 module 'indico.tests', it reported error:
No module named tests, please check your spelling and sys.path
}}}
indico is a namespace package, and there's some other egg in the
python path that shares this namespace. If I remove it, it all works
correctly.
So, my question is: is there any way I can tell sphinx to grant
priority to the code it is running on (instead of some egg that is in
the path)? is there any other way to solve this?
Since automodule is just using normal python module loading (AFAIK),
your best long term solution if you expect to have different versions of
the package you are documenting around and you need to rely on
automodule would be to learn to use virtualenv, so that you can set up a
separate python environment for your documentation build.
One simpler immediate solution would be instead of an egg you could use
your development copy of indico as your global one on python path using
``python setup.py develop`` or ``pip install -e``.
Hope that helps,
--
--Max Battcher--
http://worldmaker.net
--
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 options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] A way to reuse hyperlinks?
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: http://example.com/
You can use the rst_epilog setting in your conf.py to specify targets
and substitutions across all of your documents. (You wouldn't need
substitutions, that looks like a valid target example to me.) The value
of that setting is simply appended to all of your reST files.
(You could also create a separate file for it and use something like
``rst_epilog = file('myepilog.rst').read()`` in your conf.py. Also, if
have more than one set of includes, instead of rst_epilog you could also
manually use reST's .. include:: directive.)
If there are a lot of similar external links you may also want to
consider a custom role (such as :rfc:`822` might be used for RFC
documents) or even a missing reference fallback. If the external links
lead to other Sphinx documentation sites, you should look into the
intersphinx extension.
--
--Max Battcher--
http://worldmaker.net
--
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 options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
[sphinx-dev] how to recursively autodoc a whole project?
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 docstrings at once from entire project by giving only a name of the main module? I've tried creating a file called modules.rst with .. automodule:: :members: But this only takes out a docstring from the toplevel __init__.py and that's it. Thanks!. Evgeny. -- 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
[sphinx-dev] how to keep most developer documentation with sphinx in source code? - are there good examples?
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 good examples - I'd really like to take a look at the real-life source. Thanks! -Evgeny. -- 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] how to keep most developer documentation with sphinx in source code? - are there good examples?
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 although this doesn't sound like much it should be enough to solve the problem. -- 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] how to recursively autodoc a whole project?
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 solve this problem. -- 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] A way to reuse hyperlinks?
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 extension. In the meantime I would specify the URLs in the rst_epilog in the conf.py which gets added to every document at build time, I think that is easier then the workaround using substitutions. -- 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
