Re: Similarities to my tool - Pipp
On Thu, Feb 26, 2009 at 7:10 AM, Paul Johnston wrote: > When writing docs, I like to quite frequently look at the generated > output, usually many times before each commit. With sphinx this means > running it at the command line, then refreshing in the web browser. > With pipp and the "dev web serevr" running, I can just refresh the web > browser. I find this really handy. It seems like today is your lucky day: http://jessenoller.com/2009/02/26/sphinx-and-auto-buildingtests/ --Mike --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Re: highlighting code within a code block
On Wed, Feb 25, 2009 at 4:34 PM, anita kean wrote: > > Hello again > > In presenting blocks of code in a sphinx-generated tutorial, > there are times when a few lines are important - e.g. > they've just been changed. > > Is there a way to designate those lines for highlighting in > a particular way, for example a css-style background color change? For very basic formatting (e.g., bold), you could use the parse-literal directive: http://docutils.sourceforge.net/docs/ref/rst/directives.html#parsed-literal-block If there are more sophisticated ways to do this, such as with CSS, I'd love to hear about it. --Janet --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Re: Similarities to my tool - Pipp
Hi, > > Actually one thing Sphinx hasn't got (or I haven't found) is a web > > server mode where it automatically rebuilds docs that have changed - > > this is pretty handy in development. > Neat. > Because many VCS have a post commit hook which can be configured to > automatically upload to a server... Sure, the post-commit hook is good for your internet-facing web server. When writing docs, I like to quite frequently look at the generated output, usually many times before each commit. With sphinx this means running it at the command line, then refreshing in the web browser. With pipp and the "dev web serevr" running, I can just refresh the web browser. I find this really handy. Paul --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Re: __init__ file and autoclass_content
Hi Georg, For completeness, the automodule directive is used as follows inside an reST file: .. automodule:: :members: :undoc-members: :inherited-members: :show-inheritance: :synopsis: Plot functions Except for the problem of having the init docstring replaced by the main docstring of the class, the remaining HTML output is as expected, as far as I know. I dig a little bit inside the autodoc extension and the docstring of the __init__ method is read but somehow at some point, it is replaced by the class's docstring. cheers Thomas > > cokel...@googlemail.com schrieb: >> Dear all, >> >> I've been using Sphinx for a week now to document a python/c++ project >> and I should say that I'm quite happy about it and will pursue in this >> direction. >> >> However, I've noticed that none of the __init__ functions appear in >> the documentation pages when using the *automodule* option. >> >> Reading the sphinx documentation I figured out that I could use the >> *autoclass_content* option in the conf.py file. So, I set it to 'both' >> so as to get the docstring of the class as well as the docstring of >> the __init__ constructor. However, the result is not correct, or at >> least it is not what I expected: instead of the class docstring >> followed by the __init__'s docstring, I get the class docstring >> twice. >> >> >> Any thoughts or help on this issue ? >> cheers, >> Thomas Cokelaer >> >> PS: I was using the version 0.5.1 > > Hmm, I've tried to reproduce this, but I cannot find a problem with 0.5.1 > and an example class. How does your class look like? How do you use > autoclass/automodule? > > Georg > > > > -- Dr Thomas Cokelaer UMR DAP Avenue d'Agropolis - TA A-96/02 (Bat 2) 34398 Montpellier Cedex 5 Tel: 04 67 71 58 00 (ask number 5471) --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
inline markup for sql tables and fields?
I'm documenting a program that has some python and some sql. Sphinx is working really well and I'm quite happy with it. But I do have a question: In text like: Because the Python class User corresponds to the table users, you simply need to set User.name to update the field users.name in the database. I can mark up (and get cross referencing for) User and User.name, but is there anything similar for users and users.name? Should I just put them in ``backtics``? Jeff --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Re: __init__ file and autoclass_content
Hi Georg,
Here below is an example of a class that causes the problem.
The HTML output below the class name (and base name) is
%MatPlotLib implementation
%
%test
%
%MatPlotLib implementation
%
%test
class mplotlib(plotter):
"""
MatPlotLib implementation
test
"""
linestyles = ('-', '--', ':', '.')
pointstyles = ('o', '^', 'x', '+', 's', 'v', '>', '<')
colors = ('g', 'r', 'y', 'b', 'k', 'm', 'c')
def __init__(self):
""" Initialize matplotlib
test2"""
import matplotlib
import pylab
self.pylab = pylab
def plot(self, plotable, title, groups=[], *args, **kargs):
"""
Plot a plotable with title
groups : list of group (int) to plot
"""
thanks
Thomas
>
> cokel...@googlemail.com schrieb:
>> Dear all,
>>
>> I've been using Sphinx for a week now to document a python/c++ project
>> and I should say that I'm quite happy about it and will pursue in this
>> direction.
>>
>> However, I've noticed that none of the __init__ functions appear in
>> the documentation pages when using the *automodule* option.
>>
>> Reading the sphinx documentation I figured out that I could use the
>> *autoclass_content* option in the conf.py file. So, I set it to 'both'
>> so as to get the docstring of the class as well as the docstring of
>> the __init__ constructor. However, the result is not correct, or at
>> least it is not what I expected: instead of the class docstring
>> followed by the __init__'s docstring, I get the class docstring
>> twice.
>>
>>
>> Any thoughts or help on this issue ?
>> cheers,
>> Thomas Cokelaer
>>
>> PS: I was using the version 0.5.1
>
> Hmm, I've tried to reproduce this, but I cannot find a problem with 0.5.1
> and an example class. How does your class look like? How do you use
> autoclass/automodule?
>
> Georg
>
> >
>
--
Dr Thomas Cokelaer
UMR DAP
Avenue d'Agropolis - TA A-96/02 (Bat 2)
34398 Montpellier Cedex 5
Tel: 04 67 71 58 00 (ask number 5471)
--~--~-~--~~~---~--~~
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 options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en
-~--~~~~--~~--~--~---
placeholders not replaced in html_title
Hi there, I have a problem with html_title in conf.py. When I do not set html_title in conf.py, the title of the HTML pages is as I expect it to be. However, when I declare html_title = ' Dokumentation :: SVN rev. ' the title of all my HTML documents becones Dokumentation :: SVN rev. I also already tried replacing the <> with ||, but that doesn't help either. What am I doing wrong here? Thanks a lot! Andreas PS: version = '62' release = '62' --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
quex is using sphinx
http://quex.sourceforge.net The html documentation is still produced with asciidoc, but the first PDF has been produced with Sphinx and is ready in the download section. The Sphinx-based html version is going to be released soon. Frank --~--~-~--~~~---~--~~ 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 options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
