in order to do this, you have to use
Sphinx-specific markup (which are just extensions to ReST...roles,
directives, etc.).
Here's the link I think you're looking for:
http://sphinx.pocoo.org/markup/inline.html#ref-role
Kevin Horn
--~--~-~--~~~---~--~~
You received
at for an example of how to do
something like this:
http://git.savannah.gnu.org/cgit/kenozooid.git/tree/doc/extapi.py
Kevin Horn
--~--~-~--~~~---~--~~
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group
directive is behaving correctly. I don't really
understand what you want to do here.
Thanks in advance,
Adam
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
it's done, it's very nice!
Good luck!
Kevin Horn
I think the best you are likely to do is a partial conversion
--
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
the svn ones?
Or tell it to continue after an error? At the moment it gets the error
and stops copying files, which is annoying.
Check out the documentation here: http://sphinx.pocoo.org/config.html
especially the exclude_dirnames option.
Hope this helps...
Kevin Horn
--
You received
, but have turned it
on for some reason, just disable it, of course.
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
there be an error in your docstrings that is causing the problem?
4. Have you tried just a vanilla
.. automodule:: broadwick
without the options?
Kevin Horn
--
You received this message because you are subscribed to the Google Groups "sphinx-dev" group.
To post to this group, send email
-tables-and-doctests/
and a modified version which handles multiline cells here:
http://bitbucket.org/khorn/lore2sphinx/src/tip/table.py
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
files and settings available if there is interest.
Cheers,
Oliver
This is very nice!
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
The new domains feature in the upcoming 1.0 should be a good way forward,
assuming you can wait that long...
see: http://pythonic.pocoo.org/2009/9/12/new-in-sphinx-1-0-domains
and: http://pythonic.pocoo.org/2010/1/7/new-year-s-python-meme-and-status
Good luck!
Kevin Horn
On Tue, Feb 23, 2010
+1
2010/3/2 Fernando Gómez fjgo...@gmail.com
Hi,
Sphinx's docs mention explicitly the difference between relative and
absolute paths for the image directive [1]:
When used within Sphinx, the file name given (here gnu.png) must
either be relative to the source file, or absolute which means
a Sphinx config variable in my role
function/class? Pass the Sphinx app object into the function/class in my
extensions setup function? Or is there a better way?
Thanks,
Kevin Horn
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group
://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
can use autodoc extension but I cant figure out how. Is there
any examples to help me ?
First thing:
look in you conf.py file and make sure that 'sphinx.ext.autodoc' appears in
the extensions list
then follow the docs here: http://sphinx.pocoo.org/ext/autodoc.html
Kevin Horn
--
You received
child.parent = self
AttributeError: 'NoneType' object has no attribute 'parent'
Any idea what might be happening?
Thanks for your insight,
Andreas.
Try taking out the :maxdepth: option
Kevin Horn
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group
On Mon, Apr 5, 2010 at 3:22 AM, Georg Brandl ge...@python.org wrote:
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 05.03.2010 00:59, schrieb Kevin Horn:
I'm creating a Sphinx extension which just adds a custom docutils
role. A couple of questions:
1) What's the opinion of the list
Thanks, Georg!
Perhaps this should be added to the documentation here:
http://sphinx.pocoo.org/markup/misc.html#file-wide-metadata ?
Kevin Horn
On Sat, Jun 12, 2010 at 11:19 AM, Georg Brandl ge...@python.org wrote:
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 08.06.2010 23:16, schrieb
to actually _work_ first ;) )
Thanks for your help,
Chris
Good luck!
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
urlinclude?
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
On Thu, Aug 5, 2010 at 3:45 PM, Georg Brandl ge...@python.org wrote:
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 05.08.2010 22:12, schrieb Kevin Horn:
On Thu, Aug 5, 2010 at 8:42 AM, Georg Brandl ge...@python.org
mailto:ge...@python.org wrote:
Am 23.07.2010 17:50, schrieb
(...)
sphinxApp.builder.build_rst( .. todo :\n\ntest,
sphinx.builders.html.StandaloneHTMLBuilder,
sphinx.writers.html.HTMLWriter,
)
Have you looked at the JSONHTMLBuilder?
Kevin Horn
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group
, by
creating a custom directive, and then writing hooks into the sphinx build
system to compile the tags from various documents into a coherent whole.
I've pondered doing this, but haven't managed to come up with the time yet.
Kevin Horn
--
You received this message because you are subscribed
/groups specifically set up for ReST questions?
Many Thanks
Simon
try one of the docutils mailing lists:
http://docutils.sourceforge.net/docs/user/mailing-lists.html
Kevin Horn
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post
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
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
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
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
stuff/pre
/div
/div
Regards,
Vinay Sajip
I haven't found a way to do this yet, but it's certainly a feature I'd like
to see.
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
the stub pages for you as well.
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
with pygments.
???
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
On Wed, Jan 12, 2011 at 2:30 AM, Georg Brandl ge...@python.org wrote:
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 12.01.2011 07:43, schrieb Kevin H:
On Jan 12, 12:37 am, Kevin Horn kevin.h...@gmail.com wrote:
here is a page of output from a sphinx project:
http
RestructuredText at teh beginning or end of every
file using the rst_prolog and rst_epilog config values in your build
config file, as described here:
http://sphinx.pocoo.org/config.html#confval-rst_epilog
Is that what you were looking for?
Kevin Horn
--
You received this message because you
-integration
I usually use a fabric task myself (run manually).
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-dev@googlegroups.com.
To unsubscribe from this group, send email to
sphinx-dev
Not that I know of, though it should be fairly trivial to do.
A better solution is probably to use the extlinks extension, though, unless
your proposed wikipedia extension would do something that extlinks wouldn't.
Kevin Horn
On Fri, Mar 18, 2011 at 7:52 PM, cool-RR ram.rac...@gmail.com wrote
out the sphinx-contrib repo for examples:
https://bitbucket.org/birkenfeld/sphinx-contrib
Kevin Horn
On Fri, Mar 18, 2011 at 8:03 PM, cool-RR cool...@cool-rr.com wrote:
Can the extlinks extension replace with _, and possibly other
transformations that Wikipedia requires?
On Fri, Mar 18, 2011
because it converts it to general rst, and sphinx uses rst with some
extensions?)
kind regards,
Joris
Somewhere in the Python source tree is a script that was used to convert the
Python documentation from Latex to Sphinx/rst. Maybe that would help?
Kevin Horn
--
You received this message
and
https://bitbucket.org/khorn/lore2sphinx/src/7b0939832687/lore2sphinx/table.py
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-dev@googlegroups.com.
To unsubscribe from this group, send email
...they just don't seem to fit quite
right with the rest of the design
I hope you continue working on this. It looks really neat, and the Sphinx
world can always use more themes!
Kevin Horn
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post
The only directive might be useful too, depending on your use case.
Kevin Horn
On Mon, Aug 1, 2011 at 4:03 AM, Alastair Dent alastair.d...@imgtec.comwrote:
Hi,
I found I could do this using ifconfig extension and the exclusion list in
config.py.
The ifconfig extension allows you
this isn't exactly what you are asking, but between putting the
default in the description, and potentially having it shown in the function
signature, this seems like it would be good enough for many use cases.
YMMV
Kevin Horn
--
You received this message because you are subscribed to the Google
request to the tracker.
Thanks for this!
Kevin Horn
On Thu, Dec 15, 2011 at 11:34 AM, Vlad Riscutia riscutiav...@gmail.comwrote:
tinker --build removes the blog subdirectory under the current
directory (which should be build output) then invokes Sphinx. Indeed it
looks like if your blog root
directly from the Rst source, bypassing the LaTeX step.
YMMV.
Either way, I'd choose Sphinx over AsciiDoc, though that may be personal
preference.
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
of items 2
and 3 (so they have more than one line each)
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-dev@googlegroups.com.
To unsubscribe from this group, send email to
sphinx-dev+unsubscr
and let us know how it goes!
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-dev@googlegroups.com.
To unsubscribe from this group, send email to
sphinx-dev+unsubscr...@googlegroups.com.
For more
://bitbucket.org/birkenfeld/sphinx
Cheers,
Kevin
That would be my suggestion as well.
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-dev@googlegroups.com.
To unsubscribe from this group, send
to put .. code-block:: actionscript.
All that with no success.
TIA Vitalije
It will be easier to help you if you can show us the block you are trying
to highlight.
Kevin Horn
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group
46 matches
Mail list logo
