Hi All,
When building my docs with a Python 2.7, I still get:
docs/exceptions.txt:13: WARNING: unknown keyword: with
What's causing that? It's now obviously wrong (as opposed to just being
only technically correct in 2.6)
cheers,
Chris
--
Simplistix - Content Management, Batch Processing
Hi All,
In:
http://sphinx.pocoo.org/domains.html?highlight=param#info-field-lists
...I see :type limit: to specify the type of the `limit` parameter but
no way to specify the default of the `limit` parameter.
On a hunch, I tried :default limit:, which didn't generate any warnings
on make,
On 14/01/2011 03:58, TP wrote:
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 manual one was supposed to override the automated one?
I
Hi All,
When I do, for example:
.. autoclass:: TempDirectory
:members:
.. attribute:: path
This is the path attribute
...the attribute isn't shown in the rendered html. Why is that?
cheers,
Chris
--
Simplistix - Content Management, Batch Processing Python Consulting
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 manual one was supposed to override the automated one?
cheers,
Chris
PS: This
Hi All,
I know intersphinx supports references to python bits and pieces in
remote documentation, but how would I build a reference to section in a
remote document?
cheers,
Chris
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this
Sebastian Schaetz wrote:
On Mar 3, 11:11 pm, Chris Withers ch...@simplistix.co.uk wrote:
Hi All,
Has anyone done anything by way of flowcharts or similar with Sphinx?
Maybe the graphviz extension is what you are looking for:
http://sphinx.pocoo.org/ext/graphviz.html Graphviz allows you
Hi All,
Has anyone done anything by way of flowcharts or similar with Sphinx?
I'd like to document by way of a diagram how several python packages
work together and provide links on the diagram to drill down to further
information.
Has anyone done anything like this? If so, where can I
Georg Brandl wrote:
http://groups.google.com/group/sphinx-dev/browse_thread/thread/3368cd95a220e600
I've not yet had the time to integrate it.
Ah, okay, hope you do soon :-)
Chris
--
Simplistix - Content Management, Batch Processing Python Consulting
-
Hi All,
Please see this code here:
http://packages.python.org/broadwick/_sources/api.txt
Which generates a blank page :-(
The module I'm trying to autodoc can be found here:
http://code.google.com/p/broadwick/source/browse/#svn/tags/1.0.0/broadwick
Any idea why nothing is being shown?
Hi All,
Quite a lot of my doc writing is done while I'm commuting and either
have no internet connection or a very slow/unstable one.
Sphinx (probably intersphinx) seems to want to connect to the internet,
and so hangs in the latter case above.
I obviously want intersphinx, but is there
Lennart Regebro wrote:
already wrote. For Manuel I have to make it use sphinx doctest
parsers,
Why? What does sphinx's doctest parser do that Manuel's doctest parser
doesn't?
Chris
--
Simplistix - Content Management, Batch Processing Python Consulting
-
chrism wrote:
I used the following Sphinx branch to get page number references and
slightly better hyperlinking:
http://bitbucket.org/chrism/sphinx/
Could this be fed back into the mainstream Sphinx?
Chris
--
Simplistix - Content Management, Batch Processing Python Consulting
Lennart Regebro wrote:
On Wed, Dec 30, 2009 at 16:00, Chris Withers ch...@simplistix.co.uk wrote:
Scratch that, I got it to work now. Anyway, the code in question
*does* raise an exception, but I don't want that exception to be
rendered in the output, which still means Manuel doesn't help me
Chris Withers wrote:
Lennart Regebro wrote:
On Wed, Dec 30, 2009 at 16:00, Chris Withers ch...@simplistix.co.uk wrote:
Scratch that, I got it to work now. Anyway, the code in question
*does* raise an exception, but I don't want that exception to be
rendered in the output, which still means
Lennart Regebro wrote:
On Wed, Dec 30, 2009 at 14:38, Chris Withers ch...@simplistix.co.uk wrote:
However, it still completely refuses to execute any codeblock stuff
(or at least reports no error, even though the code is invalid). It's
also not clear to me how the output of a codeblock would
Chris Withers wrote:
Note the very subtle difference. It's a bug, but the above is a
workaround for now...
So subtle my mua ended up srewing it up...
Actually, chatting with Georg^wRDM? on IRC, it turned out to be:
from testfixtures import compare
compare(1,
... 2
Georg Brandl wrote:
Actually, chatting with Georg on IRC, it turned out to be:
Actually, that was R. David Murray, not me :)
But birkenfeld and bitdancer both start with 'bi'?! ;-)
Chris
--
Simplistix - Content Management, Batch Processing Python Consulting
-
Guenter Milde wrote:
But it should work if you put the example in an indented literal block:
Nothing to do with it :-S
All of the following block should show up in the output::
from testfixtures import compare
compare(1,
... 2)
Traceback (most recent call last):
Kevin Horn wrote:
Here's the link I think you're looking for:
http://sphinx.pocoo.org/markup/inline.html#ref-role
Yes, but why do I need to insert the dummy label before a section title?
Why can't I just use the section title?
Chris
--
Simplistix - Content Management, Batch Processing
Hi All,
The following ReST:
from testfixtures import compare
compare(1,
... 2)
Traceback (most recent call last):
...
AssertionError: 1 != 2
...is rendered by Sphinx as:
from testfixtures import compare
compare(1,
... 2)
...
AssertionError: 1 != 2
Why is the Traceback
the_...@gmx.de wrote:
I've uploaded a patch with a WIP-version
What is a WIP-version?
hacking on. It's about doctests with fixtures similar to unittests.
Have you looked at Manuel?
http://packages.python.org/manuel/
So
far it generates html output
Why are you looking for html output?
Thomas G. Willis wrote:
I guess what I would like to have is something like...
c:\project\myegg-srcpython setup.py bdist_egg
to produce...
./myegg-0.0
/docs
/myegg
/tests
But I'm not quite grokking how to get this to work.
Why would you want to include docs in an egg?
LuisC wrote:
I would like to know if after building a html documentation, it is
safe to remove the doctrees directory.
I would have thought so, yes...
Chris
--
Simplistix - Content Management, Batch Processing Python Consulting
- http://www.simplistix.co.uk
Gael Varoquaux wrote:
The one thing I find I miss from PyPI, is the ability to upload a
sphinx-generated set of HTML pages for the documentation.
But PyPI *has* this feature ;-)
Log in and go to a package you own, right down the bottom is a little
set of controls to allow you to upload a
Hi All,
Do people generally source control their package's setup.cfg?
http://docs.python.org/distutils/configfile.html sort of implies it
should be editable by the person installing the package, but I've never
personally used a package where that's the case...
Assuming the distutils docs are
Hi All,
In Sphinx docs, how would I go about documenting the return type of a
function or method?
Specifically, if a method returns an instance of a class, how can I link
to that class's documentation in the documentation for the return type
of the method?
cheers,
Chris
--
Simplistix -
Georg Brandl wrote:
For Python methods, neither return nor parameter types are supported in
a special way. (This will change; I intend to allow 3k-style annotations
at some point which could be used for type info.)
One convention, other than simply putting it into the prose, is to put doc
jhayes wrote:
Given this situation, is there any way I can get Sphinx to use our
Python interpreter instead of the locally installed version of
Python?
How are you currently running Sphinx?
Chris
--
Simplistix - Content Management, Batch Processing Python Consulting
-
Guenter Milde wrote:
The double colon starts a literal block.
Why not just:
.. topic:: myfile.py
:class:file
class MyClass:
def something(self):
pass
Okay, so the literal block works better ;-)
I'm confused as to why:
..
Hi All,
Are these pages generated by Sphinx:
http://docs.python.org/
http://sphinx.pocoo.org/
If so, where can I find their source?
cheers,
Chris
--
Simplistix - Content Management, Batch Processing Python Consulting
- http://www.simplistix.co.uk
Guenter Milde wrote:
On 2009-08-31, Chris Withers wrote:
Guenter Milde wrote:
I would rather nest the literal block in a directive, a topic, say::
.. topic:: myfile.py
::
class MyClass:
def something(self):
pass
Okay, I think I get this, but why
Guenter Milde wrote:
Suppose you wanted to compile a file such as the following::
class MyClass:
def something(self):
pass
:caption:myfile.py
The problem with this example is
...it was just a guess on my part, but looks like it served its purpose ;-)
I would
Hi All,
Is there any standard ReST was of doing captions for a literal block,
such as a code block?
just imagining:
Suppose you wanted to compile a file such as the following::
class MyClass:
def something(self):
pass
:caption:myfile.py
If not, would I need to do a
Thomas Lotze wrote:
Chris Withers wrote:
The setuptools command provided by sphinx doesn't currently make use of
the metadata provided by setup.py.
What setuptools command is provided by Sphinx? I haven't seen this
yet...
The build_sphinx command. It was added in 0.5.
How is this used
Thomas Lotze wrote:
Chris Withers wrote:
How do I automatically get the metadata from my package's setup.py into my
conf.py? (eg: version, package name, author, copyright, etc)
If it is OK for you to depend on an additional package, you could use
pkginfo in your conf.py like
Hi All,
How do I automatically get the metadata from my package's setup.py into
my conf.py? (eg: version, package name, author, copyright, etc)
I'm using setuptools if that makes it easier...
Chris
--~--~-~--~~~---~--~~
You received this message because you
chris h wrote:
OOo is a very very heavy editor not to discourage you.
I've kinda swung round to thinking about OOo again...
Yes, it's a heavy editor, that's why I want to use it. I *want* spell
checking, I want a UI that helps me rather than having to do everything
by hand.
I *don't*
James Rowe wrote:
What should happen when users have selected styling options? Say
a user has selected Arial 24 to use in a heading instead of using the
semantic option and selecting headline2(or whatever your word processor
uses) how would you cope with that during export?
Ignore it,
39 matches
Mail list logo
