Another website uses Sphinx
Hello. I would like to say thank you for all Sphinx developers! C\C++ Python language binding project ( http://language-binding.net/index.html ) is another Sphinx happy user. By the way, the idea to put all configuration into a Python file is a brilliant. Using it, I was able: * to check my embedded documentation for spelling errors * to generate documentation with few different layouts: - on-line ( with AdSense ) - off-line * to generate sitemap.xml.gz file Thanks a lot. --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Sphinx custom extension mess, and patches
Hi all,
Sorry for the multiple posting, this concerns various groups, and I'd
rather the information not be lost.
While working on getting our in-lab library ready to be merged with NiPy,
I ran into some sort of 'sphinx extension mess' where various sphinx
extension would have side effects on each other, and most important, the
extensions did not work with sphinx trunk.
I got the side effects to be limited by cleaning up the generated code
from autosummary before each run: I added the following code in my
sphinx conf.py:
# Hack: run the autosummary generation script
import shutil
if os.path.exists('generated'):
shutil.rmtree('generated')
os.system('%s sphinxext/autosummary_generate.py -o generated *.rst' %
sys.executable)
I am attaching a diff of all the modifications I made to get the various
extensions to work. I hope you can use it to get your various extensions
working on sphinx trunk quicker. For the NiPy guys, I will be committing
these changes in the fff2 tree soon, and we can go over this at the
sprint.
This does raise a problem: this extension code is all over the place, in
various repository. Some of the code cannot live in the sphinx repo, as
it introduces dependencies. However, as the extensions are not importable
from Python (I can't do 'from matplotlib.sphinxext import mathmpl'), the
different projects using them end up copying them in their repo, and thus
there are several versions floating around not updated. Some of the
extensions would do not add externa dependencies to sphinx. These should
be pushed into sphinx, with tests. That way as sphinx evolves, they do
not break.
Gaël
--~--~-~--~~~---~--~~
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 options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en
-~--~~~~--~~--~--~---
=== modified file 'doc/sphinxext/autosummary.py'
--- doc/sphinxext/autosummary.py2009-02-14 18:36:49 +
+++ doc/sphinxext/autosummary.py2009-02-15 13:41:08 +
@@ -56,7 +56,7 @@
from docutils.statemachine import ViewList
from docutils import nodes
-import sphinx.addnodes, sphinx.roles, sphinx.builder
+import sphinx.addnodes, sphinx.roles
from sphinx.util import patfilter
from docscrape_sphinx import get_doc_object
@@ -160,6 +160,7 @@
tocnode['includefiles'] = docnames
tocnode['maxdepth'] = -1
tocnode['glob'] = None
+tocnode['entries'] = []
tocnode = autosummary_toc('', '', tocnode)
return warnings + [node] + [tocnode]
=== modified file 'doc/sphinxext/inheritance_diagram.py'
--- doc/sphinxext/inheritance_diagram.py2009-02-14 18:36:49 +
+++ doc/sphinxext/inheritance_diagram.py2009-02-15 12:53:28 +
@@ -40,7 +40,10 @@
from docutils.nodes import Body, Element
from docutils.writers.html4css1 import HTMLTranslator
-from sphinx.latexwriter import LaTeXTranslator
+try:
+from sphinx.latexwriter import LaTeXTranslator
+except ImportError:
+from sphinx.writers.latex import LaTeXTranslator
from docutils.parsers.rst import directives
from sphinx.roles import xfileref_role
=== modified file 'doc/sphinxext/mathmpl.py'
--- doc/sphinxext/mathmpl.py2009-02-14 18:36:49 +
+++ doc/sphinxext/mathmpl.py2009-02-15 12:45:33 +
@@ -7,7 +7,10 @@
from docutils import nodes
from docutils.parsers.rst import directives
from docutils.writers.html4css1 import HTMLTranslator
-from sphinx.latexwriter import LaTeXTranslator
+try:
+from sphinx.latexwriter import LaTeXTranslator
+except ImportError:
+from sphinx.writers.latex import LaTeXTranslator
import warnings
# Define LaTeX math node:
=== modified file 'doc/sphinxext/only_directives.py'
--- doc/sphinxext/only_directives.py2009-02-14 18:36:49 +
+++ doc/sphinxext/only_directives.py2009-02-15 12:54:47 +
@@ -5,7 +5,10 @@
from docutils.nodes import Body, Element
from docutils.writers.html4css1 import HTMLTranslator
-from sphinx.latexwriter import LaTeXTranslator
+try:
+from sphinx.latexwriter import LaTeXTranslator
+except ImportError:
+from sphinx.writers.latex import LaTeXTranslator
from docutils.parsers.rst import directives
class html_only(Body, Element):
Re: openWNS uses Sphinx for documentation
Chris h schrieb: On Saturday 14 February 2009 13:05:49 Georg Brandl wrote: Hay...I use it to collate all my sailing research and documentation for a 5 year cruise that a friend and I are putting together. I would not advertise on the site as there is currently no content just and outline we use to collect all our thoughts and requirements as we work through all the requirements and issues. The reason I bring it up is not to draw attention to our effort, rather to point out that a good tool often has extended usage beyond its original scope and design. And Sphinx is a very good tool. User documentation for the layperson is a bit week but that's where the list comes in and it support is greatly appreciated. I would not add this site to the list as its on my own machine/workstation and comes and goes as the machine powers up and down and uses dyndns. Heck we're on a budget to smack up the cruising kitty...:) http://chrish.selfip.com/cruising/ Thanks for sharing! It's nice to see how versatile something that was once written for only one purpose can get :) Georg --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Re: Another website uses Sphinx
Roman wrote: Hello. I would like to say thank you for all Sphinx developers! C\C++ Python language binding project ( http://language-binding.net/index.html ) is another Sphinx happy user. By the way, the idea to put all configuration into a Python file is a brilliant. Using it, I was able: * to check my embedded documentation for spelling errors * to generate documentation with few different layouts: - on-line ( with AdSense ) - off-line * to generate sitemap.xml.gz file Neat. Would you care to share some/all of the techniques that you used in your config? I could see there being at least one or two generally useful recipes from what you cooked up. -- --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-dev@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 -~--~~~~--~~--~--~---
0.6 release (was Re: Pycon 2009 and Autosummary)
percious schrieb: Thanks Georg, When is 0.6 scheduled for release? Soon! I'd like to use this as an opportunity to talk a bit about 0.6: the inclusion of autosummary and/or an autogen script is the last thing missing now. What has landed in trunk today is improved theming support, which I why I want to ask as many of you as possible to test their builds with the newest trunk version. I tried to keep backwards compatibility with previous ways of customization as much as possible, so in theory nothing should break. If it does, please tell me! What you can do with the new themes: * switch between themes with a single config value * have custom templates and static files per theme * have theme options settable from conf.py that can influence the theme's templates and static files * package and use a theme easily as a zip file See http://sphinx.pocoo.org/latest/theming.html for an overview of the new theme format and configuration. cheers, Georg PS: pocoo.org currently has some server difficulties. I've redirected sphinx.pocoo.org to an alternate server for the time being; however this one is unreliable and may also be offline from time to time. Normal operation should be back by Tuesday. --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Re: Another website uses Sphinx
Roman schrieb: Hello. I would like to say thank you for all Sphinx developers! C\C++ Python language binding project ( http://language-binding.net/index.html ) is another Sphinx happy user. By the way, the idea to put all configuration into a Python file is a brilliant. Using it, I was able: * to check my embedded documentation for spelling errors * to generate documentation with few different layouts: - on-line ( with AdSense ) - off-line * to generate sitemap.xml.gz file It's now added to the list. Thanks, Georg --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Re: Another website uses Sphinx
On Feb 16, 12:56 am, Max Battcher m...@worldmaker.net wrote: Roman wrote: Hello. I would like to say thank you for all Sphinx developers! C\C++ Python language binding project (http://language-binding.net/index.html ) is another Sphinx happy user. By the way, the idea to put all configuration into a Python file is a brilliant. Using it, I was able: * to check my embedded documentation for spelling errors * to generate documentation with few different layouts: - on-line ( with AdSense ) - off-line * to generate sitemap.xml.gz file Neat. Would you care to share some/all of the techniques that you used in your config? I could see there being at least one or two generally useful recipes from what you cooked up. Okey, I will post them in a different threads --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Generating sitemap with Sphinx
Hello. I hope the following recipe will be found useful. Since Sphinx uses regular Python file, it is possible to use regular Python modules :-). To be specific, you can use :mod:atexit and sitemap_gen module @atexit.register def generate_sitemap(): if 'www' not in outdir: return try: import sitemap_gen config = your site xml configuration write file to the disk sitemap = sitemap_gen.CreateSitemapFromFile(path to the file, True) if not sitemap: print 'ERROR(SITEMAP): configuration file errors' else: sitemap.Generate() print 'ERRORS(SITEMAP): %d' % sitemap_gen.output.num_errors print 'WARNINGS(SITEMAP): %d' % sitemap_gen.output.num_warns except Exception, error: print ERROR(SITEMAP): sitemap file was not generated - , str (error) Thus, every time you update the documentation, sitemap will be updated to. The complete and working source code could be found here:http:// pygccxml.svn.sourceforge.net/viewvc/pygccxml/sphinx/conf.py? view=markup Enjoy. --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
pydsc - Python documentation string spell checker
Hello. Sometime ago, I wrote module, that checks all documentation strings and comments for spelling errors. Now, I use Sphinx for documentation and pydsc integrates nicely with it. The following is cut-and-paste of code from my conf.py file: try: import pydsc #report errors related to the project only pydsc.include_paths( project_root ) pydsc.ignore_dictionary( 'ignore_dictionary.txt' ) pydsc.set_text_preprocessor( pydsc.sphinx_preprocessor ) import pygccxml import pyplusplus except: pass #it is possible that pyenchant is not installed Every module imported after pydsc will be checked for errors. The documentation and other examples you can find here: http://language-binding.net/pydsc/pydsc.html pydsc has one advantage over other spell checkers. It tries to exclude code examples and identifiers from being checked, which decrease the number of errors from spell checker. So you actually see real errors, almost without noise. I use pydsc for both my projects and it works fine for me. May be you will find it useful for you too. Your comments are welcome. --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Re: 0.6 release (was Re: Pycon 2009 and Autosummary)
On Feb 16, 1:04 am, Georg Brandl ge...@python.org wrote: percious schrieb: Thanks Georg, When is 0.6 scheduled for release? Soon! I'd like to use this as an opportunity to talk a bit about 0.6: the inclusion of autosummary and/or an autogen script is the last thing missing now. What has landed in trunk today is improved theming support, which I why I want to ask as many of you as possible to test their builds with the newest trunk version. I tried to keep backwards compatibility with previous ways of customization as much as possible, so in theory nothing should break. If it does, please tell me! Well, if you ask :-) I just tried new version of Sphinx and found that there were some changes in a layout. I extend some blocks from layout.html and now my site generated without sidebar ( table of contents, search and etc ). Right now, I don't have time to investigate what causes the problem, but I will do this today. The following is a link to extended layout.html file: http://pygccxml.svn.sourceforge.net/viewvc/pygccxml/sphinx/__templates_www/layout.html?revision=1678view=markup --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
