[sphinx-dev] [SOLVED] Re: ReST Formatting Problem.

2010-08-18 Thread sffjunkie
If anyone wants to know the answer is to use non-breakable spaces
character code 160

On Aug 17, 10:52 am, sffjunkie sffjun...@gmail.com wrote:
 I'm not sure where else to ask but does anyone know how to include a
 literal which ends in a space character?

 More specifically I want to add 2 literals '* ' (asterisk + space) and
 '  ' (two spaces)

 Are there any forums/groups specifically set up for ReST questions?

 Many Thanks
 Simon

-- 
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] Re: MathJax

2010-08-18 Thread TP
On Tue, Aug 17, 2010 at 2:25 PM, David dwarnol...@suddenlink.net wrote:
 Kevin,

 I think developers might be following our posts. I updated (svn)
 MathJax and easy_install -U Sphinx, started anew, and the green font
 is now gone, both in Safari and Firefox.

 Your quote:

 You are correct that the minimal settings will work, however, I left
 the span and div elements in there: others might have existing CSS
 styling settings, so these wrapping elements should allow their CSS to
 be easily customized.  Would it be useful to have a mathjax.py setting
 to make this output optional?

 I don't think I know enough to answer this question. From what I have
 read (quite a bit), MathJax has ways of configuring the mathematics,
 so I don't really see a need for the class=math guys.

 But, I am very new to this.

 David.

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



I say keep it. It doesn't hurt and is helpful if people want to style
math generated stuff differently from other things. One of the
things that Sphinx 1.0 changed was adding the type of the node to
the HTML class attribute just so elements could be separately
styled. For example:

   strong class=commandrm/strong is strong/p

Given that, it's easy to change the rendering of command roles to be
italic, underlined, etc. It doesn't have to be strong (bold)
anymore.

-- 
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] .. function example in documentation doesn't work for me

2010-08-18 Thread David
All,

On: http://sphinx.pocoo.org/latest/rest.html#images

This example:

.. function:: foo(x)
  foo(y, z)
   :bar: no

   Return a line of text input from the user.

Produces this warning and doesn't render on my Macbook Pro in Safari.


/Users/darnold/Documents/temp/Sphinx/index.rst:74: (ERROR/3) Error in
function directive:
unknown option: bar.

.. function:: foo(x)
  foo(y, z)
   :bar: no

   Return a line of text input from the user.

-- 
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: .. function example in documentation doesn't work for me

2010-08-18 Thread David
Ah,

Maybe that is because it is not an example, but just a general
description of how to use a directive?

D.


On Aug 18, 11:35 am, David dwarnol...@suddenlink.net wrote:
 All,

 On:http://sphinx.pocoo.org/latest/rest.html#images

 This example:

 .. function:: foo(x)
               foo(y, z)
    :bar: no

    Return a line of text input from the user.

 Produces this warning and doesn't render on my Macbook Pro in Safari.

 /Users/darnold/Documents/temp/Sphinx/index.rst:74: (ERROR/3) Error in
 function directive:
 unknown option: bar.

 .. function:: foo(x)
               foo(y, z)
    :bar: no

    Return a line of text input from the user.

-- 
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] [SOLVED] Re: ReST Formatting Problem.

2010-08-18 Thread Kevin Horn
you might also be able to use escaped spaces, ie '\ ' (backslash followed
by a space), though I haven't tried it

It's possible that docutils uses char 160 under the covers when it sees
this in the markup, I'm not sure

Kevin Horn

On Wed, Aug 18, 2010 at 4:06 AM, sffjunkie sffjun...@gmail.com wrote:

 If anyone wants to know the answer is to use non-breakable spaces
 character code 160

 On Aug 17, 10:52 am, sffjunkie sffjun...@gmail.com wrote:
  I'm not sure where else to ask but does anyone know how to include a
  literal which ends in a space character?
 
  More specifically I want to add 2 literals '* ' (asterisk + space) and
  '  ' (two spaces)
 
  Are there any forums/groups specifically set up for ReST questions?
 
  Many Thanks
  Simon

 --
 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.comsphinx-dev%2bunsubscr...@googlegroups.com
 .
 For more options, visit this group at
 http://groups.google.com/group/sphinx-dev?hl=en.



-- 
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] Indexing

2010-08-18 Thread David
Hi,

Not sure about indexing. In Latex, I'm used to inserting and index
reference in the body of a paragraph next to the word I am indexing
(maybe I should not have been doing it that way over the years), but
with Sphinx it seems that philosophy is to insert the index in front
of the paragraph containing the word you want to appear in the index.
For example,


.. index:: good men

Now is the time for all good men to come to the aid of their
countrymen. Now is the time for all good men to come to the aid of
their countrymen. Now is the time for all good men to come to the aid
of their countrymen. Now is the time for all good men to come to the
aid of their countrymen. Now is the time for all good men to come to
the aid of their countrymen. Now is the time for all good men to come
to the aid of their countrymen. Now is the time for all good men to
come to the aid of their countrymen. Now is the time for all good men
to come to the aid of their countrymen.

Do I have this idea right?

David

-- 
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] Figure captions

2010-08-18 Thread David
All,

Is there a way to label Figures with automatic numbering, as in Figure
1, Figure 2, Figure 3, etc.? So that if later I decide to insert
another figure between Figure 2 and Figure 3, they will be
automatically renumbered?

David

-- 
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] Figure captions

2010-08-18 Thread Kevin Horn
The ability to have Sphinx auto-generate an index/list of figures or an
index/list of tables would be really nice.  I haven't found a way to do it
so far (though admittedly it's not high on my priority list).

Kevin Horn

On Wed, Aug 18, 2010 at 4:31 PM, David dwarnol...@suddenlink.net wrote:

 All,

 Is there a way to label Figures with automatic numbering, as in Figure
 1, Figure 2, Figure 3, etc.? So that if later I decide to insert
 another figure between Figure 2 and Figure 3, they will be
 automatically renumbered?

 David

 --
 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.comsphinx-dev%2bunsubscr...@googlegroups.com
 .
 For more options, visit this group at
 http://groups.google.com/group/sphinx-dev?hl=en.



-- 
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] Re: .. function example in documentation doesn't work for me

2010-08-18 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Yes, that is a general description, unfortunately using an existing
directive.  I've fixed that now online.

Thanks,
Georg

Am 18.08.2010 20:38, schrieb David:
 Ah,
 
 Maybe that is because it is not an example, but just a general
 description of how to use a directive?
 
 D.
 
 
 On Aug 18, 11:35 am, David dwarnol...@suddenlink.net wrote:
 All,

 On:http://sphinx.pocoo.org/latest/rest.html#images

 This example:

 .. function:: foo(x)
   foo(y, z)
:bar: no

Return a line of text input from the user.

 Produces this warning and doesn't render on my Macbook Pro in Safari.

 /Users/darnold/Documents/temp/Sphinx/index.rst:74: (ERROR/3) Error in
 function directive:
 unknown option: bar.

 .. function:: foo(x)
   foo(y, z)
:bar: no

Return a line of text input from the user.
 


-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.16 (GNU/Linux)

iEYEARECAAYFAkxsWNgACgkQN9GcIYhpnLDdegCfQUyneUiroY97/oH6Kqkm3O50
mo8Ani9ppyBHP7E5zY3/oORefMYRN4dj
=/Nfr
-END PGP SIGNATURE-

-- 
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] :numbered:

2010-08-18 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Am 18.08.2010 21:56, schrieb David:
 All,
 
 I have index.rst and intro.rst. In index.rst, I have:
 
 
 .. toctree::
   :maxdepth: 2
 
   intro
 
 If I change this to:
 
 
 .. toctree::
   :numbered:
 
   intro
 
 Then I get numbered sections and subsections. However, if I change
 this back to:
 
 
 .. toctree::
   :maxdepth: 2
 
   intro
 
 Then the numbers don't go away with make html. Turns out I have to
 make a little change to intro.rst to make the numbers go away.
 
 Bug?

You could call it a bug, I suppose.  In general, the check what files need
to be rebuilt is not very clever (there are also problems if you change the
order of files in toctrees).

Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.16 (GNU/Linux)

iEYEARECAAYFAkxsWN4ACgkQN9GcIYhpnLDV1gCeP7wci+A2mLZj/+mFMHJPrn1h
mfMAninWQoJFFLgCvGu79/DJGSO8WzW6
=SQg5
-END PGP SIGNATURE-

-- 
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] Indexing

2010-08-18 Thread Kevin Horn
On Wed, Aug 18, 2010 at 3:42 PM, David dwarnol...@suddenlink.net wrote:

 Hi,

 Not sure about indexing. In Latex, I'm used to inserting and index
 reference in the body of a paragraph next to the word I am indexing
 (maybe I should not have been doing it that way over the years), but
 with Sphinx it seems that philosophy is to insert the index in front
 of the paragraph containing the word you want to appear in the index.
 For example,


 .. index:: good men

 Now is the time for all good men to come to the aid of their
 countrymen. Now is the time for all good men to come to the aid of
 their countrymen. Now is the time for all good men to come to the aid
 of their countrymen. Now is the time for all good men to come to the
 aid of their countrymen. Now is the time for all good men to come to
 the aid of their countrymen. Now is the time for all good men to come
 to the aid of their countrymen. Now is the time for all good men to
 come to the aid of their countrymen. Now is the time for all good men
 to come to the aid of their countrymen.

 Do I have this idea right?

 David


For the moment I think this is the right way to do it, but I recall seeing a

ticket for adding an index role (as opposed to a directive), which I presume
(guessing) would allow you to do something like:

This :index:`term` is in the index.

I don't think this has been implemented yet, though.

Kevin Horn

-- 
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] :download: versus :doc:

2010-08-18 Thread David
All,

I'm not sure of the purpose of :doc:. I got this to work:

You can download :download:`junk.m`.

But this:

You can view :doc:`junk.m`.

Gave this warning when compile with make html.

/Users/darnold/Documents/temp/Sphinx/intro.rst:95: WARNING: unknown
document: junk.m

Bug? Or am I missing something. Not sure if I understand the
difference between :doc: and :download:.

David


-- 
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: :numbered:

2010-08-18 Thread David
Can an option be passed to make html ?

David

On Aug 18, 3:04 pm, Georg Brandl ge...@python.org wrote:
 -BEGIN PGP SIGNED MESSAGE-
 Hash: SHA1

 Am 18.08.2010 21:56, schrieb David:





  All,

  I have index.rst and intro.rst. In index.rst, I have:

  .. toctree::
     :maxdepth: 2

     intro

  If I change this to:

  .. toctree::
     :numbered:

     intro

  Then I get numbered sections and subsections. However, if I change
  this back to:

  .. toctree::
     :maxdepth: 2

     intro

  Then the numbers don't go away with make html. Turns out I have to
  make a little change to intro.rst to make the numbers go away.

  Bug?

 You could call it a bug, I suppose.  In general, the check what files need
 to be rebuilt is not very clever (there are also problems if you change the
 order of files in toctrees).

 Georg
 -BEGIN PGP SIGNATURE-
 Version: GnuPG v2.0.16 (GNU/Linux)

 iEYEARECAAYFAkxsWN4ACgkQN9GcIYhpnLDV1gCeP7wci+A2mLZj/+mFMHJPrn1h
 mfMAninWQoJFFLgCvGu79/DJGSO8WzW6
 =SQg5
 -END PGP SIGNATURE-

-- 
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: Indexing

2010-08-18 Thread David
Yep,

That's the way I'm used to doing it in Latex, though as long as the
containing paragraph is not too long, the current way seems fine.

D.

On Aug 18, 3:05 pm, Kevin Horn kevin.h...@gmail.com wrote:
 On Wed, Aug 18, 2010 at 3:42 PM, David dwarnol...@suddenlink.net wrote:
  Hi,

  Not sure about indexing. In Latex, I'm used to inserting and index
  reference in the body of a paragraph next to the word I am indexing
  (maybe I should not have been doing it that way over the years), but
  with Sphinx it seems that philosophy is to insert the index in front
  of the paragraph containing the word you want to appear in the index.
  For example,

  .. index:: good men

  Now is the time for all good men to come to the aid of their
  countrymen. Now is the time for all good men to come to the aid of
  their countrymen. Now is the time for all good men to come to the aid
  of their countrymen. Now is the time for all good men to come to the
  aid of their countrymen. Now is the time for all good men to come to
  the aid of their countrymen. Now is the time for all good men to come
  to the aid of their countrymen. Now is the time for all good men to
  come to the aid of their countrymen. Now is the time for all good men
  to come to the aid of their countrymen.

  Do I have this idea right?

  David

 For the moment I think this is the right way to do it, but I recall seeing a

 ticket for adding an index role (as opposed to a directive), which I presume
 (guessing) would allow you to do something like:

     This :index:`term` is in the index.

 I don't think this has been implemented yet, though.

 Kevin Horn

-- 
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] Indexing

2010-08-18 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Am 19.08.2010 00:05, schrieb Kevin Horn:
 On Wed, Aug 18, 2010 at 3:42 PM, David dwarnol...@suddenlink.net
 mailto:dwarnol...@suddenlink.net wrote:
 
 Hi,
 
 Not sure about indexing. In Latex, I'm used to inserting and index
 reference in the body of a paragraph next to the word I am indexing
 (maybe I should not have been doing it that way over the years), but
 with Sphinx it seems that philosophy is to insert the index in front
 of the paragraph containing the word you want to appear in the index.
 For example,
 
 
 .. index:: good men
 
 Now is the time for all good men to come to the aid of their
 countrymen. Now is the time for all good men to come to the aid of
 their countrymen. Now is the time for all good men to come to the aid
 of their countrymen. Now is the time for all good men to come to the
 aid of their countrymen. Now is the time for all good men to come to
 the aid of their countrymen. Now is the time for all good men to come
 to the aid of their countrymen. Now is the time for all good men to
 come to the aid of their countrymen. Now is the time for all good men
 to come to the aid of their countrymen.
 
 Do I have this idea right?
 
 David
 
 
 For the moment I think this is the right way to do it, but I recall seeing a
 ticket for adding an index role (as opposed to a directive), which I presume
 (guessing) would allow you to do something like:
 
 This :index:`term` is in the index.
 
 I don't think this has been implemented yet, though.

Correct on both counts :)

Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.16 (GNU/Linux)

iEYEARECAAYFAkxsWu8ACgkQN9GcIYhpnLCbmQCgkycRELzQhMVBFiz9gKBXDqXm
f1kAoISSomaPg2JoDn5ba6yTMDQteYbq
=/fq9
-END PGP SIGNATURE-

-- 
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] :download: versus :doc:

2010-08-18 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Am 19.08.2010 00:09, schrieb David:
 All,
 
 I'm not sure of the purpose of :doc:. I got this to work:
 
 You can download :download:`junk.m`.
 
 But this:
 
 You can view :doc:`junk.m`.
 
 Gave this warning when compile with make html.
 
 /Users/darnold/Documents/temp/Sphinx/intro.rst:95: WARNING: unknown
 document: junk.m
 
 Bug? Or am I missing something. Not sure if I understand the
 difference between :doc: and :download:.

:doc: is supposed to link to other *documents*, not arbitrary files.

Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.16 (GNU/Linux)

iEYEARECAAYFAkxsWw8ACgkQN9GcIYhpnLBnBwCcCaOkyWWMk5ukpSH23voQyRn9
Jd4An3MD7QMoM/GTN6pj6UCgIDXvH9ob
=BRhM
-END PGP SIGNATURE-

-- 
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] Re: :numbered:

2010-08-18 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Am 19.08.2010 00:11, schrieb David:
 Can an option be passed to make html ?

You can just say make clean html, which does a full rebuild.

Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.16 (GNU/Linux)

iEYEARECAAYFAkxsWyUACgkQN9GcIYhpnLDJswCePZPBq4aR7w2Q0B2QE9Qn+BbF
3IcAnRnhVxXVYn+WvFCSm5YpV8ngajsE
=QDIS
-END PGP SIGNATURE-

-- 
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: Figure captions

2010-08-18 Thread David
It's curious that this ability does not exist, especially in light of
the fact that it seems to exist for labeling equations.

D.

On Aug 18, 2:52 pm, Kevin Horn kevin.h...@gmail.com wrote:
 The ability to have Sphinx auto-generate an index/list of figures or an
 index/list of tables would be really nice.  I haven't found a way to do it
 so far (though admittedly it's not high on my priority list).

 Kevin Horn



 On Wed, Aug 18, 2010 at 4:31 PM, David dwarnol...@suddenlink.net wrote:
  All,

  Is there a way to label Figures with automatic numbering, as in Figure
  1, Figure 2, Figure 3, etc.? So that if later I decide to insert
  another figure between Figure 2 and Figure 3, they will be
  automatically renumbered?

  David

  --
  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.comsphinx-dev%2bunsubscr...@googlegrou 
  ps.com
  .
  For more options, visit this group at
 http://groups.google.com/group/sphinx-dev?hl=en.

-- 
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] :download: versus :doc:

2010-08-18 Thread Kevin Horn
On Wed, Aug 18, 2010 at 5:09 PM, David dwarnol...@suddenlink.net wrote:

 All,

 I'm not sure of the purpose of :doc:. I got this to work:

 You can download :download:`junk.m`.

 But this:

 You can view :doc:`junk.m`.

 Gave this warning when compile with make html.

 /Users/darnold/Documents/temp/Sphinx/intro.rst:95: WARNING: unknown
 document: junk.m

 Bug? Or am I missing something. Not sure if I understand the
 difference between :doc: and :download:.

 David



:doc: is intended for creating a link to a Sphinx document

:download: is for creating links to non-ReST files, e.g. python source
files, etc.

using :download: will also cause sphinx to put the referenced file in the
built sphinx project
(at least when building html) so that viewers of the html can download the
file

see also:
http://sphinx.pocoo.org/markup/inline.html#cross-referencing-documents

Kevin Horn

-- 
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: :download: versus :doc:

2010-08-18 Thread David
Kevin,

That's the page I am currently reading, where nothing is said in
the :doc: description that it has to be a Sphinx document. Does that
mean something like filename.rst?

D.

On Aug 18, 3:14 pm, Kevin Horn kevin.h...@gmail.com wrote:
 On Wed, Aug 18, 2010 at 5:09 PM, David dwarnol...@suddenlink.net wrote:
  All,

  I'm not sure of the purpose of :doc:. I got this to work:

  You can download :download:`junk.m`.

  But this:

  You can view :doc:`junk.m`.

  Gave this warning when compile with make html.

  /Users/darnold/Documents/temp/Sphinx/intro.rst:95: WARNING: unknown
  document: junk.m

  Bug? Or am I missing something. Not sure if I understand the
  difference between :doc: and :download:.

  David

 :doc: is intended for creating a link to a Sphinx document

 :download: is for creating links to non-ReST files, e.g. python source
 files, etc.

 using :download: will also cause sphinx to put the referenced file in the
 built sphinx project
 (at least when building html) so that viewers of the html can download the
 file

 see 
 also:http://sphinx.pocoo.org/markup/inline.html#cross-referencing-documents

 Kevin Horn

-- 
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: :download: versus :doc:

2010-08-18 Thread David
Nope.

But I get it now, as I got this to work:

View :doc:`index`.

Where index.rst is in the same directory as the calling file.

D.

On Aug 18, 3:14 pm, Kevin Horn kevin.h...@gmail.com wrote:
 On Wed, Aug 18, 2010 at 5:09 PM, David dwarnol...@suddenlink.net wrote:
  All,

  I'm not sure of the purpose of :doc:. I got this to work:

  You can download :download:`junk.m`.

  But this:

  You can view :doc:`junk.m`.

  Gave this warning when compile with make html.

  /Users/darnold/Documents/temp/Sphinx/intro.rst:95: WARNING: unknown
  document: junk.m

  Bug? Or am I missing something. Not sure if I understand the
  difference between :doc: and :download:.

  David

 :doc: is intended for creating a link to a Sphinx document

 :download: is for creating links to non-ReST files, e.g. python source
 files, etc.

 using :download: will also cause sphinx to put the referenced file in the
 built sphinx project
 (at least when building html) so that viewers of the html can download the
 file

 see 
 also:http://sphinx.pocoo.org/markup/inline.html#cross-referencing-documents

 Kevin Horn

-- 
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] Re: :download: versus :doc:

2010-08-18 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Am 19.08.2010 00:20, schrieb David:
 Kevin,
 
 That's the page I am currently reading, where nothing is said in
 the :doc: description that it has to be a Sphinx document. Does that
 mean something like filename.rst?

Yes, just without the .rst.  Document has a fixed meaning for Sphinx,
best read about it in the tutorial.

Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.16 (GNU/Linux)

iEYEARECAAYFAkxsXxMACgkQN9GcIYhpnLB4AwCgmz8S13tGSnCW4Duwzztz5KPR
mUsAoLAECK37lhBXioW7fIhcV3qCSJmg
=ubw+
-END PGP SIGNATURE-

-- 
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] menuselection

2010-08-18 Thread David
All,

The output of this command doesn't seem to be very good.

Here is :menuselection:`File--Save`

D.

-- 
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] pyparsing performance

2010-08-18 Thread Paul McGuire
Please post a link to the pyparsing wiki, I would be interested in seeing if 
there are some pyparsing optimizations that might help. (I downloaded the 
project source, but did not find any pyparsing code in it.)

-- Paul

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