Is it possible to tell glob to sort by document title rather than
document name?
--
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
sphin
As I understand it, the toctree is built at compile time, not runtime.
So normally it is built, then inserted into the html file.
So the sidebars are built, then inserted. So what you are asking for
would be quite complicated.
I use a 'local' toctree in a similar manner to what you are asking, bu
mplate toctree()
function calls. But which is that? And how would I start?
On Aug 9, 11:14 am, "Alastair Dent" wrote:
> As I understand it, the toctree is built at compile time, not runtime.
> So normally it is built, then inserted into the html file.
>
> So the sideba
my system doesn't seem to know any localtoc() function.
where can i see which functions are available in the template, and how
to use them?
thanks for your insight :)
a.
On 11 Aug., 15:40, "Alastair Dent" wrote:
> I was a bit woolly in my description, and on checking, I'm
I had a thought (wow).
In your original question, you wanted a sidebar toc that displayed a
list for a sub-grouping of docs.
Can you build each sub-group of docs separately, then just combine the
files? You would need a 'master' grouping as well, to give you an
overall toc/sitemap.
So your dir
Take a look at http://www.princexml.com/. We use it for converting html
to pdf and find the results fantastic.
-Original Message-
From: sphinx-dev@googlegroups.com [mailto:sphinx-...@googlegroups.com]
On Behalf Of Georg Brandl
Sent: 23 August 2010 15:08
To: sphinx-dev@googlegroups.com
Subj
I'm used to working with raw html and adding sections of info or
graphics that are only displayed when the user clicks a link or button.
Sometimes it's text that is expanded inline, sometimes a large version
of a graphic.
Is there a way of doing this with rst and Sphinx, or do I need to write
an
sion for this. Blast.
-Original Message-
From: sphinx-dev@googlegroups.com [mailto:sphinx-...@googlegroups.com] On
Behalf Of Guenter Milde
Sent: 15 September 2010 08:00
To: sphinx-dev@googlegroups.com
Subject: [sphinx-dev] Re: secondary windows or hidden sections in html output
On 2010-09-14,
I'll try that tomorrow, thanks.
-Original Message-
From: sphinx-dev@googlegroups.com on behalf of Max Battcher
Sent: Wed 15/09/2010 19:03
To: sphinx-dev@googlegroups.com
Subject: Re: [sphinx-dev] Re: secondary windows or hidden sections in html
output
On 09/15/2010 08:42 AM, Ala
put
On 09/15/2010 08:42 AM, Alastair Dent wrote:
> Hmm.
>
> I've tried using .. raw: html to escape and put some extra javascript
in one of the standard js files.
>
> That worked - sortof. Except that the html builder doesn't copy over
any images that aren't referenc
ps.com]
On Behalf Of Max Battcher
Sent: 16 September 2010 21:33
To: sphinx-dev@googlegroups.com
Subject: Re: [sphinx-dev] Re: secondary windows or hidden sections in
html output
On 9/16/2010 4:15, Alastair Dent wrote:
> Just re-read your email, and I'm not sure how this would work.
>
> In
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 subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email
n Mon, Sep 27, 2010 at 4:14 AM, Alastair Dent
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
Find the layout.html file for the theme you are using.
Look for 'Search' and you should find some lines like:
{%- block sidebarsearch %}
{%- include "searchbox.html" %}
{%- endblock %}
Now to decide where to put it in the header.
The template I'm using has a navigatio
t: 28 September 2010 13:55
To: sphinx-dev@googlegroups.com
Subject: Re: [sphinx-dev] Putting the search box on the top bar
On Tue, Sep 28, 2010 at 8:35 PM, Alastair Dent
wrote:
>
>
> Find the layout.html file for the theme you are using.
>
> Look for 'Search' and y
I think you've misunderstood the main usage of Sphinx.
It is used for producing documentation from commented source code, where the
comments are written in rst format.
I'd be very interested in a project that used a wiki as a source.
-Original Message-
From: sphinx-dev@googlegroups.com
In ifconfig.py I have:
def setup(app):
app.add_node(ifconfig)
app.add_directive('ifconfig', IfConfig)
app.connect('doctree-resolved', process_ifconfig_nodes)
app.add_config_value('infconf_product', 'main', True)
In an rst file I have:
.. ifconfig:: infconf_product in ('main'
dev@googlegroups.com [mailto:sphinx-dev@googlegroups.com]
On Behalf Of Alastair Dent
Sent: 19 July 2011 16:48
To: sphinx-dev@googlegroups.com
Subject: [sphinx-dev] can't get inconfig extension working.
In ifconfig.py I have:
def setup(app):
app.add_node(ifconfig)
app.add_direc
I need to be able to exclude specific rst files, depending on a built
parameter.
Is there an extension that will enable this?
--
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 un
Python 2.6
Sphinx-1.0.7-py2.6.egg
I'm using the following in conf.py
exclude_patterns = ['interface/peripheralRegion.rst', 'hdEditor/']
All files in hdEditor and the 'interface/peripheralRegion.rst' file are
included in the build.
--
You received this message because you are subscribe
ed and not used to produce html
output.
On 07/20/2011 04:28 PM, Alastair Dent wrote:
> Python 2.6
> Sphinx-1.0.7-py2.6.egg
>
> I'm using the following in conf.py
>
> exclude_patterns = ['interface/peripheralRegion.rst', 'hdEditor/']
>
> All file
good luck, i'm out :)
but anyway, it might still be helpful in general if you specified
whether or not .html is actually being generated for them, or if it's
only the sources that get copied.
good luck
On 07/20/2011 04:54 PM, Alastair Dent wrote:
> They are linked by reference
ignored and not used to produce html
output.
On 07/20/2011 04:28 PM, Alastair Dent wrote:
> Python 2.6
> Sphinx-1.0.7-py2.6.egg
>
> I'm using the following in conf.py
>
> exclude_patterns = ['interface/peripheralRegion.rst', 'hdEditor/']
>
> All files
one index masterfile.
Only possibility I see now is to create two different sphinx projects for each
division and symlink the general rst files but this does not feels as the
proper way to do it?
If somebody has some pointers on this would be nice to hear your opinion on
this.
On Jul 20, 12:3
I have one rst file with a structure like this:
dialogs.rst
.. _dialogs:
==
Codescape Dialogs
==
.. ifconfig:: ifconf_product in ('main','')
.. toctree::
:maxdepth: 1
:glob:
*
.. ifconfig:: ifconf_produc
Can I do something like the following in conf.py:
if ifconf_product='mini' then
exclude_patterns = ['interface/*.rst','dialogs/*.rst']
elseif ifconf_product='main' then
exclude_patterns = ['mini-indexes.rst]
endif
I need to exclude specific files for some builds an
f Ernesto Posse
Sent: 02 December 2011 22:29
To: sphinx-dev@googlegroups.com
Subject: Re: [sphinx-dev] Using if statements in conf.py
On Fri, Dec 2, 2011 at 11:27 AM, Alastair Dent wrote:
> Can I do something like the following in conf.py:
You can but you'll have to use Python syntax (con
n Mon, Dec 5, 2011 at 5:47 AM, Alastair Dent wrote:
> Thanks, that helps. I really don't know anything about Python - my background
> is with languages like Fortran and Pascal.
>
> How do I pass an argument to conf.py?
>
> If I were doing this in Pascal I'd de
I have two tocs in my index.rst, each contained by an ifconfig
statement.
The body of the index.rst generates correctly, with the correct toc
showing according to the parameters for ifconfig.
However, the sidebar (which contains a mini-toc based on index.rst) does
not generate correctly. It
We are testing out using Sphinx for a cross-platform app, and it looks
ok on both Windows and Linux, apart from one wrinkle. The search
function simply doesn't do anything on Linux. No error messages, just
nothing. The same doc set works perfectly on windows xp and 7.
I'm running CentOS 5 with KDE
I was building successfully using default setup. altered the
html_theme to point to a custom theme and got the following error
(build completed successfully, as far as I can tell).
Exception occurred:
File "c:\Python26\lib\site-packages\sphinx-1.0b2-py2.6.egg\sphinx
\environment.py", line 1031,
Issue solved.
I deleted the contents of my build directory.
rebuilt, and no 'test' error message was displayed.
On 28 June, 10:54, Alastair Dent wrote:
> I was building successfully using default setup. altered the
> html_theme to point to a custom theme and got the followin
I have an rst file with the following line:
.. cfunction:: DAConf [options] [command [DA-id]]
Building this results in the error message
ERROR/3 Unknown directive type "cfunction"
Why?
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group
I'd really like to mix using :glob: with manual entries in a toctree.
Is this possible?
It seems that the normal syntax is something like this:
.. toctree::
:maxdepth: 2
:glob:
dialoghelp/*
I want to put some manual entries in before the entries inserted by
glob,
34 matches
Mail list logo
