[sphinx-dev] Sphinx customised as a homepage

2009-10-24 Thread Stéfan van der Walt

Hi all,

Another example of how flexible Sphinx's templating is:

http://dip.sun.ac.za

Regards
Stéfan

--~--~-~--~~~---~--~~
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-dev] Exposing app to directive

2009-09-04 Thread Stéfan van der Walt

Hi all,

One of my directives needs to query the application configuration
variables.  What is the cleanest way to expose the app to a Directive?

At the moment, I simply do

def setup(app):
app.add_directive('person', Person)

global running_app
running_app = app


and then use the global variable inside my Person directive, but
that feels grimy.

Thanks!
Stéfan

--~--~-~--~~~---~--~~
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-dev] Email obfuscation role

2009-07-02 Thread Stéfan van der Walt
Hi,

Attached, please find an extension that helps to obfuscate e-mail
addresses in HTML.

Use it as follows:

:email:`Name Surname u...@myplace.org` - renders as Name Surname
with the appropriate mailto link
:email:`u...@myplace.org` - renders as u...@myplace.org with the
appropriate mailto link

I make use of

http://pypi.python.org/pypi/bud.nospam

that encodes the e-mail address using ROT13 and generates a javascript
snippet such as:

  pscript type=text/javascriptdocument.write(
  n uers=\znvygb:fgrsna\100fha\056np\056mn\Fgrsna ina
qre Jnyg \057n.replace(/[a-zA-Z]/g,
  function(c){
return String.fromCharCode(
(c=Z?90:122)=(c=c.charCodeAt(0)+13)?c:c-26);}));
/script/p

Good luck spambots :-)

Enjoy!
Stéfan

--~--~-~--~~~---~--~~
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
-~--~~~~--~~--~--~---



hide_email.py
Description: Binary data


[sphinx-dev] Re: wiring sphinx into building source distros?

2009-06-30 Thread Stéfan van der Walt

Hi Chris

2009/6/30 Chris Withers ch...@simplistix.co.uk:
 I'd like my source distros to include generated sphinx output in html
 and pdf.

 Has anyone done this? If so, how?

Would you like to generate those documents via your setup.py?  You can
have a look at what Enthought is doing with their setupdocs tool:

http://pypi.python.org/pypi/SetupDocs/1.0.2

Regards
Stéfan

--~--~-~--~~~---~--~~
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-dev] Allow ifconfig to include titles

2009-06-30 Thread Stéfan van der Walt
Hi,

I use the ifconfig extension to select between languages.  It
doesn't currently allow titles to appear, so the following breaks:

.. ifconfig:: mylanguage

   Goeiedag
   
   Ek skryf hier...

.. ifconfig:: yourlanguage

   Guten Tag
   =
   Ich schreibe einmal...

I think (hope?) the attached patch is enough to fix the issue.

Regards
Stéfan

--~--~-~--~~~---~--~~
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
-~--~~~~--~~--~--~---



ifconfig.patch
Description: Binary data


[sphinx-dev] Re: wiring sphinx into building source distros?

2009-06-30 Thread Stéfan van der Walt

2009/6/30 Chris Withers ch...@simplistix.co.uk:
 http://pypi.python.org/pypi/SetupDocs/1.0.2

 This doesn't look like it uses Sphinx...

 What does it use?

It uses Sphinx (at least, I see Sphinx mentioned many times in the sources).

After installing SetupDocs, you should be able to do something like

from setuptools.command.develop import develop

class MyBuild(distbuild):
def run(self):
distbuild.run(self)
self.run_command('build_docs')

setup(
...
'build': MyBuild,
)

Cheers
Stéfan

--~--~-~--~~~---~--~~
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-dev] ifconfig variable setup

2009-06-29 Thread Stéfan van der Walt

Hi all,

I experimented with the ifconfig extension, and it looks like, in
order to create a new variable, you need to do the following in
conf.py:

myvar = 1

def setup(app):
app.add_config_value('myvar', myvar, True)

If I leave out the first or the second definitions of myvar, then
Sphinx complains.  Is this the way it's supposed to work?  If so, I'll
write a patch to the docs to describe it more clearly.

Thanks
Stéfan

--~--~-~--~~~---~--~~
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
-~--~~~~--~~--~--~---