Re: toctree is empty

[Chris Mahan]

On Mon, Jan 26, 2009 at 2:47 PM, Georg Brandl  wrote:

>
> Chris Mahan schrieb:
> >
> >
> > On Mon, Jan 26, 2009 at 1:55 PM, Georg Brandl  > > wrote:
> >
> >
> > Christopher Mahan schrieb:
> > > toctree does not output anything. what could be wrong?
> >
> > Do your included documents have titles?
> >
> >
> > There are no included documents. There is just one document (index.rst).
>
> Ah. In that case, no output is expected :)
>
>
So what do I use to show the table of content for the latex -> pdf output?

--~--~-~--~~~---~--~~
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: toctree is empty

[Georg Brandl]

Chris Mahan schrieb:
> 
> 
> On Mon, Jan 26, 2009 at 1:55 PM, Georg Brandl  > wrote:
> 
> 
> Christopher Mahan schrieb:
> > toctree does not output anything. what could be wrong?
> 
> Do your included documents have titles?
> 
>  
> There are no included documents. There is just one document (index.rst).

Ah. In that case, no output is expected :)

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: double hyphens still become emdash in PDF

[Georg Brandl]

jeneha...@gmail.com schrieb:
> Though I upgraded to v0.5.1, the only time double hypens representing
> options do not become an emdash in PDF is when used in literal
> blocks.  There are times I need to list or refer to options not in the
> literal block format and so am requesting that the options list and
> inline literals format change so that the double hypens remain in
> PDF.  Thank you.

Thanks for the report, this is indeed a bug.  Should now be fixed in trunk.

cheers,
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: toctree is empty

[Chris Mahan]

On Mon, Jan 26, 2009 at 1:55 PM, Georg Brandl  wrote:

>
> Christopher Mahan schrieb:
> > toctree does not output anything. what could be wrong?
>
> Do your included documents have titles?
>

There are no included documents. There is just one document (index.rst).

Chris

--~--~-~--~~~---~--~~
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: Parsing Cross-references in a Description Unit

[Phil Thompson]

On Mon, 26 Jan 2009 23:03:10 +0100, Georg Brandl  wrote:
> Phil Thompson schrieb:
>> Hi,
>> 
>> I'm writing a simple extension that implements a new description unit.
>> 
>> I'm having difficulty working out how to handle cross-references in the
>> node parser. I want something like...
>> 
>> .. myunit: Foo(:class:`~Bar.Baz`)
>> 
>> ...to work as expected.
>> 
>> I assume I need to add pending_xref nodes, but I'm not sure exactly how
-
>> or I am on the wrong track?
> 
> I'd try to get docutils to process the directive argument with the
standard
> inline markup parser, like this (in the directive function):
> 
> inodes, messages = state.inline_text(arguments[0], lineno)
> 
> "inodes" is a list of resulting nodes, while "messages" are possible
system
> messages if something went wrong.
> 
> See the author_directive function for how that call is used in Sphinx.

Does this mean I can't use add_description_unit() and have to use
add_directive() instead?

Otherwise how do I get access to state?

Thanks,
Phil

--~--~-~--~~~---~--~~
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: "Enter search terms" doesn't get translated

[Georg Brandl]

Luc Saffre schrieb:
> Hello,
> 
> here is another small bug report:
> 
> The string "Enter search terms or a module, class or function name."
> (below the quick search entry field) doesn't get translated. I didn't
> find myself any explanation. But you can easily reproduce this error by
> creating a new project using sphinx-quick-start.py, modifying the
> ``language=None`` line ``language='de'``, then running `` make html``.
> Most parts are then in German, but this text not.

I suspect it is because it is not translated.  I've updated the German
translation in trunk; if it works there that is the reason.

> BTW, in the case of non-software websites this isn't a very helpful text
> since visitors won't know what "module, class or function name" means. I
> solved this for my multi-lingual website by modifying the sidebarsearch
> block of my custom layout.html::
> 
> {%- block sidebarsearch %}
> {%- if pagename != "search" %}
>
> {{ _('Quick search') }}
>   
> 
> 
> 
> 
>   
>   {{ dict(
>   de='Geben Sie einen oder mehrere Suchbegriffe ein.',
>   fr='Entrez un ou plusieurs mots à rechercher sur ce site.',
>   nl='Geef éen of meerdere woorden om erna te zoeken.'
>   ).get(language,'Enter search terms you want to find on this
> site.') }}
> 
>   $('#searchbox').show(0);
> {%- endif %}
> {%- endblock %}

I understand that this is a bit clumsy...

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: Customizing Latex styles?

[Georg Brandl]

Janet Swisher schrieb:
> How would I go about customizing the sphinx.sty file, or adding my own
> style file? It looks like I would have to modify the sphinx texinputs
> directory. Is there a way to do this on a per-project basis?

Not really.  If you don't have too much to customize, I'd advise to put
it into one of the latex_elements entries.

Even for larger files: Remember that conf.py is executed, so you can
read in a file and put it into the latex_elements entry right inside
conf.py.

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: Parsing Cross-references in a Description Unit

[Georg Brandl]

Phil Thompson schrieb:
> Hi,
> 
> I'm writing a simple extension that implements a new description unit.
> 
> I'm having difficulty working out how to handle cross-references in the
> node parser. I want something like...
> 
> .. myunit: Foo(:class:`~Bar.Baz`)
> 
> ...to work as expected.
> 
> I assume I need to add pending_xref nodes, but I'm not sure exactly how -
> or I am on the wrong track?

I'd try to get docutils to process the directive argument with the standard
inline markup parser, like this (in the directive function):

inodes, messages = state.inline_text(arguments[0], lineno)

"inodes" is a list of resulting nodes, while "messages" are possible system
messages if something went wrong.

See the author_directive function for how that call is used in Sphinx.

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: How to have a colored background for the code blocks in the generated PDF

[Georg Brandl]

ksachdeva schrieb:
> Hi,
> 
> Inspired from the django documentation system I have adopted sphinx
> for writing my documentation. It is really fantastic piece of work.
> Thanks for the hard work you  have put into it.
> 
> In my documentation I have some code fragments and in the generated
> HTML I am able to have a colored background (using css inspired from
> django docs). This colored background helps in distinguishing the code
> blocks from the normal text.
> 
> http://docs.djangoproject.com/en/dev/intro/overview/#intro-overview
> 
> The above page shows the output which has green background for code
> blocks
> 
> I am now wondering how to have the similar thing for the PDF that I
> generate from the latex.

You can enable this in your latex_preamble setting, using e.g.

\definecolor{VerbatimColor}{rgb}{1,0,0}
\definecolor{VerbatimBorderColor}{rgb}{0,0,0}

to define a red background with black border for code blocks.

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: toctree is empty

[Georg Brandl]

Christopher Mahan schrieb:
> toctree does not output anything. what could be wrong?

Do your included documents have titles?

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: where does sphinx looks for images for?

[MishaS]

On Jan 26, 10:35 pm, Georg Brandl  wrote:
> > While changing ``Image`` to ``image`` and ``.option_spec`` to
> > ``.options`` I got it to ``.run()``, where I am now completely
> > clueless.
>
> > Could you please help? :)
>
> So you're running docutils 0.4.x -- I think it should work if, in
> addition to your replacements, you replace Image(...).run() by
> image().
Yes, it works and I managed to implement what was wanted: getting
images from application icons directory. :)  Thank you!

--
Misha
--~--~-~--~~~---~--~~
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: literalinclude problem - workaround

[Georg Brandl]

Tarantula schrieb:
> Hello, I've spent many hours with this problem and I want to share if
> someone have the samee, I don't know if this solution will be commited
> to some revision, by the way:
> 
> I'm including a python file with:
> 
> .. literalinclude:: file.py
> 
> But the syntax highlight never worked, so I've seen on silent
> exception on (highlighting.py), on line 148:
> 
> try:
> parser.suite(src)
> except parsing_exceptions, a:
> return False
> else:
> return True
> 
> The parser was throwing an exception: "syntax error". But the source
> was not with any syntax error. So I took a look in the code.py to see
> how the file is open, and I saw:
> 
> f = codecs.open(fn, 'r', encoding)
> 
> The problem here, is that codecs.open will always open files in binary
> mode to avoid data loss, so the automatic "\n" conversion is never
> done on reading.

Thanks for the report!  I believe just opening in universal newline mode
('rU') will fix this; I've made that change in the repo now.

cheers,
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: Report on an error when building documentation (Sphinx r0.5.1)

[Georg Brandl]

Pierre Vinet schrieb:
>  >> It looks like these files are corrupted. Can you send me one of  
> them?
> 
> I send you Sphinx-0.5.1/doc/ext/builderapi.rst
> 
> Fooling around with files of my own, I finally found that the titles  
> are recognized if the rst file begin with a backslashed whitespace,  
> ie.::
> 
>   \
> 
>   The Title
>   =

I couldn't find anything unusual in the file you sent me.  This is very
strange :)

Anyway, I fixed the KeyError you encountered in trunk, so that at least
no exception should be raised during the build.

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: Changing current module inside a numbered list - how?

[Georg Brandl]

Vinay Sajip schrieb:
> 
> 
> On Jan 22, 7:17 pm, Georg Brandl  wrote:
>> Instead, use :class:`~handlers.FileHandler` or somesuch -- the tilde
>> will remove everything before the last name part from the output
>> while pointing to the right class.
> 
> This is a good suggestion, thanks very much. Sorry I missed this - the
> Python docs (e.g. 
> http://docs.python.org/documenting/markup.html#inline-markup)
> are (understandably) less up to date than the Sphinx ones (e.g.
> http://sphinx.pocoo.org/markup/inline.html?highlight=class%20reference).

Indeed; I've now added this information.

> I had another thought about class references. If I use
> a :class:`MyClass` reference, this links to the .. class:: MyClass
> target, which by convention is used for the class constructor.
> However, it's often desirable for it to link to some sort of overview
> section which describes the class, before leading on to sections
> describing the constructor and other methods. For example, in
> logging.rst, for each handler, I have a brief para describing the
> handler before the constructor is documented. Is there room for a
> (new) role such as e.g. :class-overview: for such a purpose, or is
> there a better way (than use of :ref:) of achieving links to class
> overview sections?

Since they all seem to have a heading, I think :ref: is fine here.

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: Always rebuilds everything, even with no changes

[Georg Brandl]

e...@heliusdesigns.com schrieb:
> I have 629 files, so it takes a long time to build the project. It
> seems like Sphinx is designed to only build files that have changed,
> which would be very nice and save me a lot of time. But it always
> rebuilds everything:
> 
> Sphinx v0.5.1, building html
> loading pickled environment... done
> building [html]: targets for 0 source files that are out of date
> updating environment: 0 added, 629 changed, 0 removed
> 
> This is under Windows. Any ideas? Any other information you need to
> figure this out?

How are you calling sphinx-build?

Do you have any special dependencies in the files?

If no, I'm not sure what could happen there.  I've performed a small
test on Windows and it looks like the basic detection of changes to
files works.  Do you have a filesystem that doesn't record mtimes?

If none of this helps, you'd have to step through the code a bit to
see what exactly trips it up.

cheers,
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: Using the '-c' option on the sphinx-build

[Georg Brandl]

Werner F. Bruhin schrieb:
> The doc states that various other files need to be present in this 
> location/path when one uses this option.
> 
> Is there a list of these files which need to be in the same folder and 
> what files/folder need to be relative to this folder?

There's no list as such, but all config values that specify paths
relative to the configuration path are documented to do that;
see e.g. templates_path.

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: Multiple folders for images

[Georg Brandl]

Werner F. Bruhin schrieb:
> I need different folders depending on what build I am running.
> 
> I put the image folders into the "conf" folder, but it seems that the 
> ".. image::" and ".. figure::" directives look relative to the source 
> folder.
> 
> So, I tried using a substitution but without success either.
> 
> .. figure:: |imagebasefolder|_screenimages/dialogPurchaseNewWine.png
> 
> Is there a way of doing the above without having to resort to renaming 
> or copying whole folders with all the images on each build?

I'd recommend a similar approach to what I suggested here:

http://groups.google.com/group/sphinx-dev/msg/40b9fc3b0ae9546d

cheers,
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: where does sphinx looks for images for?

[Georg Brandl]

MishaS schrieb:

>> Your problem could be solved by a custom image directive, e.g. add this
>> to your conf.py (this assumes docutils 0.5):
>>
>> from docutils.parsers.rst.directives.images import Image
>>
>> def platimage_directive(desctype, arguments, options, content, lineno,
>> content_offset, block_text, state, state_machine):
>> # run the standard Image directive
>> ret = Image('image', arguments, options, content, lineno,
>> content_offset, block_text, state, state_machine).run()
>> # fetch the config value and modify the URI of the image node
>> env = state.document.settings.env
>> ret[-1]['uri'] = env.config.platform + '/' + ret[-1]['uri']
>> # return everything the image directive returned
>> return ret
>>
>> def setup(app):
>> # register the new directive and the new config value
>> app.add_directive('platimage', platimage_directive, 0, (1, 0, 1),
>>   **Image.option_spec)
>> app.add_config_value('platform', 'win', True)
>>
>> Then use .. platimage:: instead of .. image:: and set the "platform"
>> value in conf.py accordingly.
> Thanks for the suggestion! :)  I could not get this working though:
> Image is not available in the specified module (maybe, I'm using a
> wrong version of docutils, however the standard ``.. image:`` works
> just fine).
> 
> While changing ``Image`` to ``image`` and ``.option_spec`` to
> ``.options`` I got it to ``.run()``, where I am now completely
> clueless.
> 
> Could you please help? :)

So you're running docutils 0.4.x -- I think it should work if, in
addition to your replacements, you replace Image(...).run() by
image().

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: where does sphinx looks for images for?

[MishaS]

Hi Georg,

On Jan 22, 8:43 pm, Georg Brandl  wrote:
> >> (Maybe I did not RTFM well enough.  Sorry, if it's the case)
>
> >> I'm writing documentation for an application and there are two things
> >> I do not know how to do :)
>
> >> 1. I would like to refer to toolbar images application offers, however
> >> I do not really want to copy images to the directory where
> >> documentation sources reside.
>
> >> 2. The application has slightly different icons depending on the
> >> target platform.  I'd like the documentation to show correct icons
> >> when generated for those different platforms.
>
> image paths are always relative to the directory of the document that
> contains them.
>
> Your problem could be solved by a custom image directive, e.g. add this
> to your conf.py (this assumes docutils 0.5):
>
> from docutils.parsers.rst.directives.images import Image
>
> def platimage_directive(desctype, arguments, options, content, lineno,
>                         content_offset, block_text, state, state_machine):
>     # run the standard Image directive
>     ret = Image('image', arguments, options, content, lineno,
>                 content_offset, block_text, state, state_machine).run()
>     # fetch the config value and modify the URI of the image node
>     env = state.document.settings.env
>     ret[-1]['uri'] = env.config.platform + '/' + ret[-1]['uri']
>     # return everything the image directive returned
>     return ret
>
> def setup(app):
>     # register the new directive and the new config value
>     app.add_directive('platimage', platimage_directive, 0, (1, 0, 1),
>                       **Image.option_spec)
>     app.add_config_value('platform', 'win', True)
>
> Then use .. platimage:: instead of .. image:: and set the "platform"
> value in conf.py accordingly.
Thanks for the suggestion! :)  I could not get this working though:
Image is not available in the specified module (maybe, I'm using a
wrong version of docutils, however the standard ``.. image:`` works
just fine).

While changing ``Image`` to ``image`` and ``.option_spec`` to
``.options`` I got it to ``.run()``, where I am now completely
clueless.

Could you please help? :)

--
Misha
--~--~-~--~~~---~--~~
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: disturbing warnings

[Luc Saffre]

On 24.01.2009 20:38, Georg Brandl wrote:
> Ah yes, links create explicit targets in docutils.
> 
> You can circumvent that by using two underscores after the link, like
> `Minimes `__

Thanks for the helpful answer.
Luc

--~--~-~--~~~---~--~~
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: Always rebuilds everything, even with no changes

[Luc Saffre]

On 23.01.2009 20:10, e...@heliusdesigns.com wrote:
> I have 629 files, so it takes a long time to build the project. It
> seems like Sphinx is designed to only build files that have changed,
> which would be very nice and save me a lot of time. But it always
> rebuilds everything:
> 
> Sphinx v0.5.1, building html
> loading pickled environment... done
> building [html]: targets for 0 source files that are out of date
> updating environment: 0 added, 629 changed, 0 removed
> 
> This is under Windows. Any ideas? Any other information you need to
> figure this out?

Maybe you have changed your computer's date/time between two builds. Did
you try to do a "make clean" once?

And I once had similar effects when the source (or build) files where
stored on a file server whose clock wasn't correct.

Luc


--~--~-~--~~~---~--~~
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: Hoping for some help getting started

[cimarron]

I use Sphinx on OSX without difficulty. I would start by looking at
what is your conf.py file, in particular the setting for
templates_path.

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

Parsing Cross-references in a Description Unit

[Phil Thompson]

Hi,

I'm writing a simple extension that implements a new description unit.

I'm having difficulty working out how to handle cross-references in the
node parser. I want something like...

.. myunit: Foo(:class:`~Bar.Baz`)

...to work as expected.

I assume I need to add pending_xref nodes, but I'm not sure exactly how -
or I am on the wrong track?

Thanks,
Phil

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

How to have a colored background for the code blocks in the generated PDF

[ksachdeva]

Hi,

Inspired from the django documentation system I have adopted sphinx
for writing my documentation. It is really fantastic piece of work.
Thanks for the hard work you  have put into it.

In my documentation I have some code fragments and in the generated
HTML I am able to have a colored background (using css inspired from
django docs). This colored background helps in distinguishing the code
blocks from the normal text.

http://docs.djangoproject.com/en/dev/intro/overview/#intro-overview

The above page shows the output which has green background for code
blocks

I am now wondering how to have the similar thing for the PDF that I
generate from the latex.

I am on Windows Vista and use MikeTex for PDF generation.

Would really appreciate your help and advise.

Regards & thanks
Kapil

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

toctree is empty

[Christopher Mahan]

toctree does not output anything. what could be wrong?


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