[sphinx-dev] JavaScript documentation (and tutorial) using Sphinx
Hi 'll be giving a tutorial on JavaScript at the EuroPython conference later this month, and to support this I've written some documentation (using Sphinx, of course). You can download the latest (and earlier) versions at http://bitbucket.org/jfine/javascript-for-python-programmers/downloads To use the documentation, download the latest zip file, unzip it, and open the index.html within it in your browser. I'd really appreciate your comments and, if you like it, offers to help make it more complete and better. You might like to compare what I've done to https://developer.mozilla.org/en/javascript http://docs.python.org/ BTW, I colleague at work said of Sphinx "I was fairly impressed. This is a great presentation vehicle. I love it." best regards Jonathan -- 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] autodoc and subpackages
In my python project I use subpackages with modules. Currently I have a package called rijnh, which contains a package called platform which contains a module named system. I have created the following directive: The :mod:`rijnh.platform.system` Module .. automodule:: rijnh.platform.system :members: :undoc-members: :show-inheritance: (actually I've used the 'generate modules.py' file, but I've also tried it by hand). However in the build process I've got the following error: H:\workspace\rijnh\doc\source\rijnh.platform.txt:9: (WARNING/2) autodoc can't im port/find module 'rijnh.platform.system', it reported error: "No module named pl atform.system", please check your spelling and sys.path I've added the source path to sys.path, I have even added src/rijnh and src/rijnh/platform to the path, but no success. The path however is correct. If I create a simple test module in the source directory (no packages), it has no trouble documenting it. So, does autodoc support subpackages? I've seen examples of that it should, but I can't get it to work. Regards, Vincent -- 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] Re: autodoc can't import/find class
Moderators: No need to actually post this thread, I think. Wow, ok I found my problem, which of course had nothing to do with Sphinx. I learned that Sphinx actually executes the code and reports any runtime errors. So, I fixed my code and everything works fine. -- 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] Re: autodoc can't import/find class
I have narrowed the problem to my code (which works fine). The problem is the class inheritance: Sphinx likes this: from engine.spiders.amazon_sell_base import AmazonSellerSpider class AmazonSellerSpiderInteractive (): but Sphinx does not like this: from engine.spiders.amazon_sell_base import AmazonSellerSpider class AmazonSellerSpiderInteractive (AmazonSellerSpider): -- 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] autodoc can't import/find class
I have two automodules, but only one works: in spiders.rst: http://pastie.org/1031678 output: http://pastie.org/1031679 and the dir structure: http://pastie.org/1031682 why does the first automodule work and the second one doesn't? -- 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] Using :glob:
I'd really like to mix using :glob: with manual entries in a toctree. Is this possible? It seems that the normal syntax is something like this: .. toctree:: :maxdepth: 2 :glob: dialoghelp/* I want to put some manual entries in before the entries inserted by glob, and have a title before the glob bit. Is this possible? -- 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.
