2012/7/23 Martin Bless :
> Hello everybody,
>
> maybe there is an obvious solution - but I just don't see it.
>
> At the end of 'conf.py' I want to read and parse an additional
> 'Settings.yml' configuration file and add those settings to what we
> already have in 'conf.py'. If present settings fro
Am 16. März 2012 11:34 schrieb Andrea Crotti :
> On 03/16/2012 10:31 AM, Daniel Neuhäuser wrote:
>>
>> A colon has to follow the hash like #: so in order for Sphinx to pick it
>> up as a doc string for that attribute.
>>
>>
>
> Ah great thanks, just to check, is it written anywhere? Because it's no
Am 14. März 2012 06:17 schrieb Andrea Crotti :
> I'm having some troubles understanding the wonders of sphinx-build..
> So in mailman 3 we have a perfectly working "python setup.py build_sphinx",
> that reads the setup.cfg file with the following:
>
> [upload_docs]
> upload_dir: build/sphinx/html
>
2011/9/20 ashwin :
> Hi All,
>
> I have a requirement in which I need to do the following:
>
> a. Generate documentation for different set of products.
> b. For all these products, there would be only one set of REST files.
> c. We want to have a feature flag in these REST files.
>
> This is requi
2011/8/31 Sebastian Rahlf :
>>> Hi!
>>>
>>> I'm using Sphinx's autodoc feature to document my API. For example::
>>>
>>> DEFAULT_OPTION = 'default'
>>> def do_something(msg, option=DEFAULT_OPTION):
>>> print msg
>>>
>>> The generated documentation now shows the following signature:
>>>
2011/8/30 Sebastian Rahlf :
> Hi!
>
> I'm using Sphinx's autodoc feature to document my API. For example::
>
> DEFAULT_OPTION = 'default'
> def do_something(msg, option=DEFAULT_OPTION):
> print msg
>
> The generated documentation now shows the following signature:
>
> do_something(m
2011/2/8 Johan Ekh :
> Hi
>
> I'm trying to distribute my python package and would like the distribution
> to also hold the documentation (both html and pdf).
> I can't figure out how the setup.py file should look like. Can anyone point
> me in the right direction?
If you are using setuptools or d
(self, normalize(signature))
def __missing__(self, signature):
# look up normalized signature in the tag file
HTH
Sebastian Wiesner
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to sphinx-...@googlegro
ne
for Sphinx, together with a special keyword (I like
"sphinx.extension") is a reasonable and nice idea.
Sebastian Wiesner
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to sphinx-...@googl
Hi,
http://bitbucket.org/birkenfeld/sphinx-contrib seems to be kind of
semi-official third-party extension repository for Sphinx, some
extensions developed in this repository are also released on PyPI as
"sphinxcontrib-*". However, this repository is neither mentioned in
the Sphinx documentation
On Friday 16 April 2010 11:52:11 Sebastian Wiesner wrote
> On Thursday 15 April 2010 00:23:32 Tim Michelsen wrote
>
> > > - "lunar.sphinx.ext.issuetracker": Link issue references like #10 to
> > > the issue trackers in GitHub or BitBucket.
> >
> >
On Thursday 15 April 2010 00:23:32 Tim Michelsen wrote
> > - "lunar.sphinx.ext.issuetracker": Link issue references like #10 to the
> > issue trackers in GitHub or BitBucket.
>
> What to you think about Launchpad, Sourceforge and Google Code?
No objections, I'm just not using any of these servic
Hi,
I've written a couple of extensions for Sphinx, that you may or may not find
useful:
- "lunar.sphinx.ext.programoutput": Include the output of programs into
documentation
- "lunar.sphinx.ext.ansi": Parse ANSI color sequences in program output and
color HTML output
- "lunar.sphinx.ext.iss
At Tuesday 25 August 2009 00:58:06
> 2) How can I sort members using autodoc in the order they were
> defined?
autodoc imports the module and analyzes its namespace, which is an unordered
dictionary. The order of definition cannot be restored from this dictionary.
You have to discard the ":membe
Wednesday 26 November 2008 17:58:52 Werner F. Bruhin
> Is there any editor out that which assist with .rst markup?
Docutils comes with an emacs mode, which supports ReST Editing with some
shortcuts and syntax highlighting.
--
Freedom is always the freedom of dissenters.
r that.
I wrote something up, the mercurial changeset is attached.
--
Freedom is always the freedom of dissenters.
(Rosa Luxemburg)
# HG changeset patch
# User Sebastian Wiesner <[EMAIL PROTECTED]>
# Date 1227644959 -3600
# Node ID 5d35960e9a
Sunday 23 November 2008 21:29:05 Georg Brandl
> Gael Varoquaux schrieb:
> > Hey guys,
> >
> > Sorry to be lazy, but I can't find a quick way to do this: I want a
> > scaled down image, using:
> >
> > .. image:: foobar.jpg
> >
> > :scale: 50
> >
> > but I want it also to be a link to the image i
Friday 14 November 2008 18:16:17 Fredrik Johansson
> On Fri, Nov 14, 2008 at 5:44 PM, Sebastian Wiesner
>
> <[EMAIL PROTECTED]> wrote:
> > Friday 14 November 2008 17:17:26 Fredrik Johansson
> >
> >> 1. Inline equations need proper vertical alignment.
> >
Friday 14 November 2008 17:17:26 Fredrik Johansson
> 1. Inline equations need proper vertical alignment.
Proper vertical alignment is supported by Sphinx, but depends on the latex-
preview package. Since this package is not available everywhere, Sphinx does
not use it by default. But if you're
Sunday 09 November 2008 20:32:58 Georg Brandl
> Hans Fangohr schrieb:
> > Dear all,
> >
> >> Alaric Haag schrieb:
> >>> Hello,
> >>>
> >>> The Sphinx page bills it as a tool for documenting Python projects. I
> >>> perceive it to be more of a "document management tool" that uses
> >>> ReST.
> >>> I
Wednesday 05 November 2008 19:27:13 Alaric Haag
> Hello,
>
> The Sphinx page bills it as a tool for documenting Python projects. I
> perceive it to be more of a "document management tool" that uses ReST.
> I've barely scratched the surface of using it though.
>
> So, I'm considering using it to mak
The attatched traceback shows the exception, that is raised, if sphinx
attempts to load documents from directories, whose names contains non-ascii
characters (german umlauts in this case).
The directory layout of the specific project is as follows:
[...]
./conf.py
./index.rst
./Einführung in di
Thursday 02 October 2008 19:06:26 Georg Brandl
> Mike Hansen schrieb:
> > Hello,
> >
> > I was running into some issues installing the SVN version of Sphinx.
> > It's the same issue as is here:
> > http://groups.google.com/group/sphinx-dev/browse_thread/thread/1ececc7336
> >4fbca0 . The problem is
Hello list,
I need to admit, that I failed to add a required import for SystemMessage
class in setup_command.py. The attached patch fixes this. Sorry for the
inconvenience.
--
Freedom is always the freedom of dissenters.
(Rosa Luxemburg)
Index: sphinx/se
#x27;Deprecated')}}:{% endif %}
{{ synops|e }}
{%- endif -%}
Index: sphinx/_jinja2.py
===
--- sphinx/_jinja2.py (Revision 0)
+++ sphinx/_jinja2.py (Revision 0)
@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+
+"""
+sphinx._jinja2
chris <[EMAIL PROTECTED]> at Tuesday 19 August 2008, 19:19:47
> This gives me the same result (invalid command). Is there something in
> particular I have to import?
No, but you need to have *Sphinx 0.5* correctly installed.
This sphinx version hasn't yet been released, so you will have to use a
chris <[EMAIL PROTECTED]> at Tuesday 19 August 2008, 18:48:42
> Invalid command 'build_doc'
My bad, its "build_sphinx". Sorry for the inconvenience.
> Do I have to specify it in the setup.py?
If your setup.py uses setuptools and sphinx was correctly installed,
setuptools will use entrypoints to
chris <[EMAIL PROTECTED]> at Tuesday 19 August 2008, 00:56:11
> How does one use this?
python setup.py build_doc
--
Freedom is always the freedom of dissenters.
(Rosa Luxemburg)
signature.asc
Description: This is a digitally signed message part.
28 matches
Mail list logo
