On Mon, Mar 22, 2010 at 2:55 PM, Warren Weckesser
warren.weckes...@gmail.com wrote:
Is it possible to prevent the restructured text sources from being included
in the HTML generated by Sphinx? Currently I get the restructured text
copied to a _sources directory, and the HTML files have links
In the lastest trunk revision of Sphinx, when section numbers are turned on via:
.. toctree::
:numbered:
They look like
1. Section
1.1. Subsection
In my opinion this looks ugly. I'd rather have:
1 Section
1.1 Subsection
Here's some changes that allow you to specify a custom
In order to turn off docutils HTML compact-list behavior (simulate
passing --no-compact-lists on the rst2html command line), I do the
following in sphinx/builders/__init__.py Builder.build(), right before
the environment is pickled:
if self.config.html_compact_lists:
http://sphinx.pocoo.org/rest.html#substitutions says:
If you want to use some substitutions for all documents, put them into
a separate file and include it into all documents you want to use them
in, using the include directive. Be sure to give the include file a file
name extension differing
.. include:: /include.rst
in the file c:\docs\project\subdir\index.rst
looks for c:\include.rst instead of looking in the top source directory
c:\docs\project\include.rst.
Conversely, the image directive docs
(http://sphinx.pocoo.org/rest.html#images) say:
.. image:: gnu.png
When used
) and avoid includes altogether.
On Mon, Mar 29, 2010 at 12:30 PM, Max Battcher m...@worldmaker.net wrote:
TP wrote:
Additionally, in the latest trunk revision, the unused_docs conf.py
option no longer works, so if you change the name back to include .rst,
you then get the WARNING: document isn't
I use emacs and rst.el.
On Mon, Mar 29, 2010 at 1:21 PM, Tim Michelsen
timmichel...@gmx-topmail.de wrote:
I was wondering what type of editor everyone uses for editing Sphinx rst
files. I've spent a great deal of time perusing the internet finding a ton
of different things including some
I implemented rst_prologue option in conf.py here:
http://bitbucket.org/tpowers/sphinx/changeset/c5ad17aa65cb/ (it's only
a few changed lines).
On Mon, Mar 29, 2010 at 7:29 PM, Fernando Perez fperez@gmail.com wrote:
On Mon, Mar 29, 2010 at 2:42 PM, TP wing...@gmail.com wrote:
However
ePub generation is in the development version. See
http://sphinx.pocoo.org/latest/builders.html#sphinx.builders.epub.EpubBuilder.
On Wed, Mar 31, 2010 at 2:38 PM, Roberto Alsina
rals...@netmanagers.com.ar wrote:
A while ago, there was some mention of work on an ePub builder. Was there any
On Thu, Apr 1, 2010 at 8:21 AM, Paulette pziegf...@gmail.com wrote:
Hi,
Is there any way to link from logo in the side bar of the
documenation OR from the relation bar to web address? (Currently from
any place in the docs, clicking on the logo or rel bar text takes you
to the main TOC.)
On Thu, Apr 1, 2010 at 3:28 PM, TP wing...@gmail.com wrote:
On Thu, Apr 1, 2010 at 8:21 AM, Paulette pziegf...@gmail.com wrote:
Hi,
Is there any way to link from logo in the side bar of the
documenation OR from the relation bar to web address? (Currently from
any place in the docs, clicking
On Mon, Mar 29, 2010 at 11:48 PM, werner wbru...@free.fr wrote:
I use UliPad, but it has the same limitations - it would be nice if there is
a way to preview a single .rst file - with Sphinx directives also working,
but I don't think there is such a build command in Sphinx at this time -
would
On Thu, Apr 8, 2010 at 7:30 AM, Jan Ulrich Hasecke
juhase...@googlemail.com wrote:
I found
{%- if customsidebar %}
{% include customsidebar %}
{%- endif %}
in layout.html
How can I use it. I did not find customsidebar in the documentation.
juh
See
On Thu, Apr 8, 2010 at 11:34 PM, malthe mbo...@gmail.com wrote:
In my document I have two types of text blocks corresponding to user's
text input and output. How do I tell Sphinx to assign a particular
HTML-class to each of them (e.g. input, output) such that I may
assign different colors in a
On Mon, Apr 12, 2010 at 8:33 AM, Michael Rule mrule7...@gmail.com wrote:
I would like to preserve source ordering in my documentation. I tried adding
autodoc_member_order = 'groupwise'
to the conf.py file, but this doesn't seem to do anything. What is the
proper way to turn off alphabetical
'
at the bottom of conf.py would work, if I had this version ?
and I assume there is some way to update to this version ?
On Mon, Apr 12, 2010 at 12:15 PM, TP wing...@gmail.com wrote:
On Mon, Apr 12, 2010 at 8:33 AM, Michael Rule mrule7...@gmail.com wrote:
I would like to preserve source ordering in my
2010/4/13 Václav Šmilauer oty...@gmail.com:
Hi there,
I am not sure whether this is Firefox-specific... I am not able to see
SVG figures in HTML output, with Firefox 3.6.3. It doesn't display
anything at all, just blank space. Those SVG were created byt
inkscape. Is it possible that Firefox
On Mon, Apr 19, 2010 at 4:10 AM, mark mark.fi...@googlemail.com wrote:
Hi Georg,
I pulled 0.66 from the repository this morning. Now the sidebars
disappeared. I tried to fix it with additional configurations but so
far I had no luck. I created a new documentation with quickstart and
this has
On Fri, Apr 16, 2010 at 8:57 AM, gslindstrom gslindst...@gmail.com wrote:
Hello,
We are starting a large project where I work and I would like to start
documenting it *now* rather than later. Sphinx looks like the ideal
tool for the job (I've been playing with it for a month or two but,
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
My recent suggestion to add back the smartypants.py processEscapes()
function
(http://bitbucket.org/birkenfeld/sphinx/issue/498/add-escape-sequences-to-smartypants-quote)
was just rejected with the comment:
I'm against an additional escaping mechanism
additional? How does one currently go
On Tue, Aug 24, 2010 at 4:04 PM, Fernando Perez fperez@gmail.com wrote:
On Tue, Aug 24, 2010 at 2:58 PM, Kevin Dunn kgd...@gmail.com wrote:
You can compare how the same HTML page is shown with MathJax or with
Sphinx's built-in pngmath extension:
* mathjax:
On Wed, Aug 25, 2010 at 12:12 AM, TP wing...@gmail.com wrote:
On Tue, Aug 24, 2010 at 4:04 PM, Fernando Perez fperez@gmail.com wrote:
On Tue, Aug 24, 2010 at 2:58 PM, Kevin Dunn kgd...@gmail.com wrote:
You can compare how the same HTML page is shown with MathJax or with
Sphinx's built
On Mon, Sep 27, 2010 at 4:14 AM, Alastair Dent alastair.d...@imgtec.com wrote:
In some html files I'd like to place a local toc. The variable 'toc' would
seem to do the trick, but how do I insert it?
Should I define a block in the layout.html?
--
You received this message because you are
On Thu, Oct 21, 2010 at 8:39 AM, Jacob Kaplan-Moss ja...@jacobian.org wrote:
On Thu, Oct 21, 2010 at 10:09 AM, Maarch monbast...@yahoo.fr wrote:
I'm trying to use Sphinx to provide a documentation site for my
company. We develop an open source software and our source code it's
not accessible
I've wondered for a while how the Sphinx home page at
http://sphinx.pocoo.org/index.html is created. Unlike all the other
pages on the site there isn't a Show Source link. It also doesn't seem
to be in http://bitbucket.org/birkenfeld/sphinx/src/tip/doc/.
I like the idea of having the Home page be
On 10/21/10, SHIBUKAWA Yoshiki yosh...@shibu.jp wrote:
Hi,
I've wondered for a while how the Sphinx home page at
http://sphinx.pocoo.org/index.html is created. Unlike all the other
pages on the site there isn't a Show Source link. It also doesn't seem
to be in
On 10/21/10, TP wing...@gmail.com wrote:
On 10/21/10, SHIBUKAWA Yoshiki yosh...@shibu.jp wrote:
Hi,
I've wondered for a while how the Sphinx home page at
http://sphinx.pocoo.org/index.html is created. Unlike all the other
pages on the site there isn't a Show Source link. It also doesn't seem
On Wed, Nov 10, 2010 at 4:08 AM, qx guy qx0mons...@googlemail.com wrote:
I have the exact same issue using |version|. I want to include it in
links (which e.g. point from the documentation to online demos which
follow the same version scheme).
I think there is a general issue with inline
On Wed, Nov 17, 2010 at 3:16 AM, qx guy qx0mons...@googlemail.com wrote:
On Nov 11, 8:34 am, TP wing...@gmail.com wrote:
rst_prolog=
.. |versionG| replace:: :guilabel:`%s`
% (version,)
So now I can do:
Right-click :guilabel:`blah-`\ |versionG| to do foo.
Thanks for this tip
On Thu, Jan 13, 2011 at 9:35 AM, Curiouslearn curiousle...@gmail.com wrote:
@TP Thanks! If you don't mind, can you send me an example of your
subtitle css. Also, did you save it in _static.
in my conf.py file I have:
html_theme = 'customtheme'
html_theme_path = ['.']
in my customtheme\static
On Thu, Jan 13, 2011 at 11:18 AM, Curiouslearn curiousle...@gmail.com wrote:
Hello All,
Two questions about sharing Sphinx documentation with others:
(1) Do you know of an easy way of private hosting of Sphinx documents
online (where you can restrict access to it)? Is there a web host or
On Thu, Jan 13, 2011 at 9:32 AM, Curiouslearn curiousle...@gmail.com wrote:
@Federico: Thanks so much. This is great.
@Daslch: Thanks. Do I just save my css file in the _static directory
and then invoke the styles I define there using raw html directive.
Thanks again.
Here's what I do. In
On Thu, Jan 13, 2011 at 2:33 PM, Chris Withers ch...@simplistix.co.uk wrote:
Hi All,
If I do, for example:
.. automodule:: testfixtures
.. class:: Comparison
...then I end up with two sections for the Comparison class, one
auto-generated and one with my manual bits.
I thought the
with its docstring that generated the documentation).
-- TP
--
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
On Mon, Feb 21, 2011 at 8:08 AM, werner wbru...@free.fr wrote:
On 21/02/2011 16:44, TP wrote:
For one example of how to document a Python method see
http://tpgit.github.com/MDIImageViewer/imageviewer.html#imageviewer.ImageViewer.scaleImage.
Click on the [source] link on the right to see
for CSV Tables. See
http://docutils.sourceforge.net/docs/ref/rst/directives.html#id1 for
details.
--TP
--
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
On Tue, May 24, 2011 at 12:37 PM, Philip Austin
austin.phili...@gmail.com wrote:
(pre-question: anyone know how to get a plain textbox for posting?
I've tried to attach the actual rst file in case spacing get corrupted
by the non-wysiwyg widget)
I'm trying to automate the production of tables
On Tue, Nov 1, 2011 at 7:07 PM, Friedrich Romstedt
friedrichromst...@gmail.com wrote:
The following rst snipped causes some trouble. I see and appreciate the
mechanism that complex or rather complex enough list items are rendered
using paragraphs and so all list items, the problem is, that
On Sun, Nov 20, 2011 at 7:35 PM, Kristina Hoeppner
kris.hoepp...@googlemail.com wrote:
Hello,
I started to write the Mahara documentation (http://manual.mahara.org)
in rst last week and we use Sphinx to publish it to Read the Docs.
Most things work great. :-)
Is it possible to exchange the
On Sat, Mar 3, 2012 at 7:25 AM, Rita rmorgan...@gmail.com wrote:
Hello,
I am building a HTML table which is in a file and I would like to inject
that into my rst file. Is it possible to include that into a document?
See
On Sat, Mar 3, 2012 at 9:07 PM, Rita rmorgan...@gmail.com wrote:
How can I disable the search box? It doesnt seem to work.
See http://sphinx.pocoo.org/config.html#confval-html_sidebars
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to
On Sun, Apr 22, 2012 at 6:14 AM, Doug Hellmann doug.hellm...@gmail.com wrote:
In your case, you probably want to build a custom role processor
Or perhaps use the standard sphinx.ext.extlinks extension [1].
[1] http://sphinx.pocoo.org/ext/extlinks.html
--
You received this message because you
On Fri, Jun 22, 2012 at 5:59 AM, Tobias Oberstein
tobias.oberst...@gmail.com wrote:
Is there a way to add some JS to $(document).ready() for every page
generated by Sphinx via configuration (thus avoid patching the generated
stuff afterwards)?
You can do this by using the *basic* theme's
On Wed, Jun 27, 2012 at 1:18 AM, Kevin Hunter hunt...@gmail.com wrote:
Hullo Sphinx List,
I believe I have a case where I need specific content based on the final
output format. Is there a way to tell Sphinx to only use a certain section
of the ReST document based on the final output format?
On Thu, Jun 28, 2012 at 1:15 PM, Kevin Hunter hunt...@gmail.com wrote:
The final one gets what I want, but man that's ugly. Do I just live with it
or is there a cleaner avenue?
Maybe you can at least use a substitution [1] to hide the ugliness?
[1]
On Thu, Jul 26, 2012 at 7:37 PM, Chris Boorman gull...@gmail.com wrote:
I'm using Sphinx to help me generate docs for a Python API, and I can't find
a way to generate a complete Table of Contents. I can only get Sphinx to
auomatically generate entries for the the current page. Since my pages
On Tue, Aug 7, 2012 at 7:34 AM, Viktor Haag
viktor.h...@desire2learn.com wrote:
This of course only helps people that are using a theme that supports
html_sidebars. My docs use ..contents:: to put in floating page-only TOCs,
and I like that. Having a way to also provide a table of contents page
On Thu, Aug 16, 2012 at 8:10 AM, Boris Kheyfets kheyfbo...@gmail.com wrote:
Is it possible to impose a word-wrap in code-block?
For HTML, I do something like the following in the theme's css file:
pre {
white-space: pre-wrap;
}
--
You received this message because you are
On Thu, Oct 4, 2012 at 1:40 PM, RBH Dev rbhd...@gmail.com wrote:
At the top of my HTML generated files, I'd like to have a table of contents
of all sections of the current page. How do I do that? And can I add a
back to top button at the end of each section?
See [1] which points to [2].
[1]
50 matches
Mail list logo
