[sphinx-dev] edition via the web proposed as a branch or patch

2011-10-19 Thread Jean-Daniel
Hello, I was wondering there was some code running somewhere to present the modification done by a user in his browser into a patch or a branch in a repository of Sphinx sources. This feature adds the simplicity of the browser for quick edition to the existing much more powerful controls made

[sphinx-dev] domain supported in literalinclude's pyobject

2010-12-18 Thread Jean-Daniel
Hello, I am a big fan of literalinclude and especially its pyobject option [1]. For those not familiar with, this extract an object from a Python source file to display the formatted source code. Before that, I would the option lines and would have to count which lines of the source file to be

[sphinx-dev] linking to specific sections of an RFC

2010-07-23 Thread Jean Daniel
Hello, I am using the :rfc:`3501` role to express this url : http://tools.ietf.org/html/rfc3501 This works fine and I am looking for a way to link to a specific section of the rfc; I would like to link to http://tools.ietf.org/html/rfc3501#section-2.3.1.1 I have tried

[sphinx-dev] a shortcut for :doc:`script_1` and .. literalinclude:: script_1.rst

2010-07-23 Thread Jean Daniel
Hello When writing tutorials and articles, I find myself writing repetitively the same boiler plate pattern. I want a link to a page showing a colorized, highlighted, formatted version of an iteration of the script in progress. Here is what I do: 1. I write :doc:`script_1` 2. then write a

[sphinx-dev] broken start-after and end-before options for literalinclude directive

2010-01-28 Thread Jean Daniel
Hello, Testing the :start-after: option for the literalinclude sphinx directive does not yield the expected result with sphinx 0.6.4 and 0.6.3. It does not work neither with my current document in latex nor with a pristine documentation project in html. Here is the file *titi*, I would like to

Re: [sphinx-dev] Re: guide to theming/templating Sphinx?

2009-12-12 Thread Jean Daniel
thanks, maybe this it. This will do. On Mon, Dec 7, 2009 at 11:59 PM, nickmalcolm nickmalc...@gmail.com wrote: You may be looking for this? http://www.proven-corporation.com/2008/03/27/sphinx-templates/ Nick On Dec 8, 5:40 am, Jean Daniel jeandaniel.bro...@gmail.com wrote: Hello, I

[sphinx-dev] Fwd: repetitive url pattern

2009-12-07 Thread Jean Daniel
Hello, When editing a changelog, to include a link to the description of a ticket, I constantly use the following pattern : `#233 http://internal_ticket_tracker/projects/specs/ticket/233`_ Only the ticket number changes.  What is the cleanest way to have a shortcut for this repetitive pattern?

[sphinx-dev] guide to theming/templating Sphinx?

2009-12-07 Thread Jean Daniel
Hello, I remember about a good article about being discussed on how to make a new theme and templates for a Sphinx site, but I can't find the article again. Does anyone has a link outside sphinx.pocoo.org, toward an comprehensive guide about how to theme Sphinx? Thank you, -- You received

[sphinx-dev] Re: faster sphinx-to-gihtub script

2009-11-13 Thread Jean Daniel
Hello, Make sure to rename the '_sources' directory in the searchtool.js, line 389, or else the search page will not work correctly (I think this directory name is hardcoded). In the python script, this is 'if file.endswith(.html) or file.endswith(.js)', in bash this is 'find -type f' without

[sphinx-dev] Re: faster sphinx-to-gihtub script

2009-11-13 Thread Jean Daniel
Also, I read searchtool.js, it is a super cool gem. Very smart ! Cheers, On Fri, Nov 13, 2009 at 3:01 PM, Jean Daniel jeandaniel.bro...@gmail.com wrote: Hello, Make sure to rename the '_sources' directory in the searchtool.js, line 389, or else the search page will not work correctly

[sphinx-dev] different conf.py for different pdf

2009-10-13 Thread Jean Daniel
Hello, I use sphinx to generate pdf specifications in our company. I usually have one directory per document (roughly a dozen directories) with the conf.py and the master document in each. I get a nice pdf and all is well until product management kicks in and wants to participate and validate

[sphinx-dev] formatting to restructured text from XML

2009-09-30 Thread Jean Daniel
Hello, I would like to modify a restructured text document from a script. The script would 1. load the restructured text as XML, 2. alter the structure of the XML document, add a few nodes, 3. and format the XML back to restructured text. Which tools can help me with step 3? I would like to

[sphinx-dev] Re: raw external file in preformatted style

2009-08-20 Thread Jean Daniel
If you're using sphinx, how about the `literalinclude` directive?    http://sphinx.pocoo.org/markup/code.html The literal include is indeed very featureful, I'll need this for python code. Thank you. I am not sure I am happy there are two commands though. Maybe I wish the standard include

[sphinx-dev] Re: raw external file in preformatted style

2009-08-20 Thread Jean Daniel
I skipped that :literal: part on the first read, I should do better. This is exactly what I wanted. Thanks for your help, On Thu, Aug 20, 2009 at 9:56 AM, Guenter Mildemi...@users.berlios.de wrote: On 2009-08-19, Jean Daniel wrote: Hello, I would like to include in my pdf an external

[sphinx-dev] raw external file in preformatted style

2009-08-19 Thread Jean Daniel
Hello, I would like to include in my pdf an external file. It is some text which should not be interpreted, just included as is preferably in preformatted style. The documentation seems to say this is the way: .. raw:: html :file: inclusion.html

[sphinx-dev] Re: Catching up soon

2009-07-24 Thread Jean Daniel
I'm sorry I haven't been active lately; I've been ill and had exams before, Ok fine... but don't be ill again ! :) I am glad you are better, I hope your exams went fine, Cheers but that should be over now, so I promise to get back to all unread threads here, and all new issues, soon.

[sphinx-dev] Re: wiring sphinx into building source distros?

2009-06-30 Thread Jean Daniel
Hello, I include in one my debian package a man page which is rendered from rst into the man format when building the package. It is specific to debian packaging system, the shell command is included in the 'build' phase of the debian/rules. Cheers On Tue, Jun 30, 2009 at 1:44 PM, Chris

internal links not translated to tex

2009-05-06 Thread Jean Daniel
Hello, I am build an empty pdf which only renders the internal link example from the Sphinx Documentation: .. _my-reference-label: Section to cross-reference -- This is the text of the section. It refers to the section itself, see

best practice for small business documentation

2009-05-03 Thread Jean Daniel
Hello all, We are evaluating to use Sphinx to generate our internal RD documentation and specifications and we are thinking at the best way to layout the sources and the released pdf so that traceability and maintenance are not too difficult. In our context, developers consume specs and