Re: [sphinx-dev] ReStructuredTextToolsForGedit
Hi Justin, On 29/03/2010 21:43, Justin Rosen wrote: I was wondering what type of editor everyone uses for editing Sphinx rst files. I've spent a great deal of time perusing the internet finding a ton of different things including some WYSIWYG editors. I've just recently come across a plugin for gedit on linux. http://textmethod.com/wiki/ReStructuredTextToolsForGedit This comes with a preview window which uses docutils to generate it's output. This works great, except that it doesn't like the sphinx directives. It looks like the plugin boils down to this single line from docutils.core import publish_string html = publish_string(text, writer_name='html') Is there similar code for using sphinx? import sphinx html = sphin.FUNCTION(text, ...) I use UliPad, but it has the same limitations - it would be nice if there is a way to preview a single .rst file - with Sphinx directives also working, but I don't think there is such a build command in Sphinx at this time - would be very happy if someone would correct me on this. Werner -- 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 sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
[sphinx-dev] Re: ReStructuredTextToolsForGedit
On 2010-03-30, werner wrote: I use UliPad, but it has the same limitations - it would be nice if there is a way to preview a single .rst file - with Sphinx directives also working, but I don't think there is such a build command in Sphinx at this time - would be very happy if someone would correct me on this. I was thinking about a Sphinx-compatibility backend for Docutils that would allow this. It should define sensible fallbacks for the Sphinx-specific roles and directives. I don't know how large the effort to do this would be, as Sphinx and Docutils are drifting apart more and more. Günter -- 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 sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Re: ReStructuredTextToolsForGedit
On Tuesday 30 March 2010 04:21:44 Guenter Milde wrote: On 2010-03-30, werner wrote: I use UliPad, but it has the same limitations - it would be nice if there is a way to preview a single .rst file - with Sphinx directives also working, but I don't think there is such a build command in Sphinx at this time - would be very happy if someone would correct me on this. I was thinking about a Sphinx-compatibility backend for Docutils that would allow this. It should define sensible fallbacks for the Sphinx-specific roles and directives. I don't know how large the effort to do this would be, as Sphinx and Docutils are drifting apart more and more. And unnecesarily :-( Most of the sphinx directives could be hacked so they worked as addons to docutils (by creating a sphinx-rst2html or whatever and just registering the directives). I am talking about graphviz, code blocks, production lists, and others. -- 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 sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Included non-rst files not copied to _source directory
I implemented rst_prologue option in conf.py here: http://bitbucket.org/tpowers/sphinx/changeset/c5ad17aa65cb/ (it's only a few changed lines). On Mon, Mar 29, 2010 at 7:29 PM, Fernando Perez fperez@gmail.com wrote: On Mon, Mar 29, 2010 at 2:42 PM, TP wing...@gmail.com wrote: However, as described in my Include directive doesn't correctly support 'absolute' paths message, includes seem to be useless when used from multiple subdirs in the same project. Unless I'm missing something, there doesn't seem to be any easy way to use the same include directive from multiple subdirs. You might be able to use different 'relative' paths depending on where you are including from but that seems more bother than it's worth. Instead, for now, I'll just implement a rst-prologue conf.py option (analogous to the rst-epilog option) and avoid includes altogether. My (hackish, ugly but functional) solution to this is to use include: foo.txt and in *every* directory (but the project topmost one, of course), have a symlink foo.txt - ../foo.txt so they eventually all resolve at the top. Not pretty, but works for me :) Cheers, f -- 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 sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- 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 sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
[sphinx-dev] [GSoC] Port to Python 3.x and Integration of sphinx.web
Hello, I am planning on applying to GSoC to port Sphinx to Python 3 and integrate sphinx.web(last year's GSoC project) into Sphinx. Basically these are two projects but Georg pointed out that just one of the two is probably too short for the GSoC. As proposed by the Wiki i would like to get some feedback on the first draft of my proposal. However currently i have now idea how to handle the timeline as there is no way of knowing what issues occur during the project, so a timeline is not included in my proposal. I would be grateful if anybody could point me into the right direction there because a timeline seems to be expected for every project. -- Daniel Neuhäuser GSoC 2010 Sphinx: Port to Python 3.x and Integration of `sphinx.web` :Last change: Monday March 30 16:09:16 CEST 2010 :Status: Draft .. contents:: Table of Contents Abstract Beginning with the `Python Documentation`_ Sphinx_ managed to become the documentation generator for python projects, however as of now Sphinx requires Python_ 2.x to run, although 3.0 was released on the 3 December 2008 [1]_. Not being able to run Sphinx_ with Python_ 3.x is a major issue for a lot of projects planning to switch. Therefore the first part of my proposal is to port Sphinx_ to Python_ 3.x to resolve this issue and hopefully help more projects to make the change to 3.x The second part of my proposal is to pick up `sphinx.web`, the Google Summer of Code project from last year [2]_ and integrate it into Sphinx_ which has not yet been accomplished. This is important in order to be able to involve a project's community into the development process of a documentation, to improve the user experience of the `Python Documentation`_ and to further establish Sphinx_. Implementation -- Port to 3.x ^^^ Branching Sphinx_ and porting it to 3.x manually takes a lot of work in itself and requires maintenance of two different branches. Although this is should be possible to handle it the goal should be to avoid it. Instead we use the tools introduced with Python 2.6: `python -3`_ Starting the python interpreter with the `-3` option enables warnings about incompatibilities to Python 3.x which cannot fixed using 2to3_. Running the test suite using this option should warn us about every serious problem which could occur later, these should be fixed manually as far as possible and pushed to the main branch as soon as possible, keeping the differences between the code created during this project and the Sphinx_ code as small as possible. 2to3_ 2to3_ is a tool introduced with Python_ 2.6 which allows automatic transformation of Python_ 2.x code to Python_ 3.x. The transformation process is done using so called `fixers` which are responsible for the transformations for specified cases. The standard library and therefore 2to3_ already provides a set of fixers_ which handle almost all code however we might need to provide our own. Jinja2_ one of Sphinx_'s dependencies does the latter. The porting will be done in tree steps: 1. Checking if the test suite has full code coverage and if not extending the test suite to reach that goal. 2. Run the test suite with `python -3` to find and fix incompatibilities as described above. As much as possible of this work should be done in the main branch. 3. Integrate 2to3_, using the techniques described above and merge everything into the main branch. Integration of `sphinx.web` ^^^ The current implementation of `sphinx.web` needs to be merged with the main branch. As the latest change was made on the 19 august 2009 it might be necessary to make some changes to get it working and make it possible to port it with 2to3_ which will then be a requirement. Once this is done `sphinx.web` should be pushed to the main repository. However it is to be expected that improvements have to be made to get it accepted. About me My name is Daniel Neuhäuser, i am 18 years old and currently in the eleventh grade of the `Bergstadt Gymnasium Lüdenscheid`_. I started programming with Python_, as my first language, in May 2008 and have been experimenting with a couple of other languages since then [3]_. I teached myself software development and consider myself an active member of the german and english speaking Python_ community. My interested lies in the
[sphinx-dev] add_description_unit - control output?
I've been using an extension with the following line, in order to document and catalog requirements: app.add_description_unit(directivename = 'requirement', rolename = 'req') Now I'd like to customise the output of the directive, but that's where I'm stuck. The documentation says: If you provide parse_node, it must be a function that takes a string and a docutils node, and it must populate the node with children parsed from the string. It must then return the name of the item to be used in cross-referencing and index entries. See the ext.py file in the source for this documentation for an example. Unfortunately I can't seem to find any such ext.py file anywhere, so I don't know where to start in figuring out how to use this. Can anyone help? -- 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 sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
[sphinx-dev] [GSoC] Support for other languages via doxygen
Hi all, My name is Leon from National University of Singapore and I would like to participate in GSoC this year for Sphinx. I would like to develop support for documenting languages other than python via doxygen. Currently doxygen does a good job in parsing source code and extracting relevant comments, but many features on sphinx are more superior (e.g. javascript-based search, ReST format, better document flow, and even a web-based dynamic interface if the other proposal gets accepted :)). However, automatic extraction of module, function etc. documentations are only supported in Python. By utilising the capability of doxygen to extract inline documentation from other source formats, sphinx can be an ideal documentation tool for a lot of projects. To approach this project I would create a new sphinx extension and parse doxygen-generated XML files to provide the necessary autodocs like http://sphinx.pocoo.org/ext/autodoc.html. There are some preliminary parsing code done by WxWidgets community: http://groups.google.com/group/wxPython-dev/browse_thread/thread/83dd29510a4992de http://trac.wxwidgets.org/browser/wxWidgets/trunk/docs/doxygen/scripts/doxymlparser.py I have a pretty good idea of how the project is supposed to be done, but I am hesitant to apply as the main focus of this year's Python GSoC is to port applications to Py3k. Do I still have a good chance to get in if I propose this project? Regards, Leontius Adhika Pradhana [P.S. I am aware of the idea from LLVM community, but using CLang would mean that only C, C++, and ObjC were going to be supported. By contrast doxygen supports far more languages.] -- Leontius Adhika Pradhana (Leon) http://leapon.net/ -- 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 sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Re: ReStructuredTextToolsForGedit
Thanks for the info, I'll stick with syntax highlighting for now! On Tue, Mar 30, 2010 at 3:22 AM, Roberto Alsina rals...@netmanagers.com.arwrote: On Tuesday 30 March 2010 04:21:44 Guenter Milde wrote: On 2010-03-30, werner wrote: I use UliPad, but it has the same limitations - it would be nice if there is a way to preview a single .rst file - with Sphinx directives also working, but I don't think there is such a build command in Sphinx at this time - would be very happy if someone would correct me on this. I was thinking about a Sphinx-compatibility backend for Docutils that would allow this. It should define sensible fallbacks for the Sphinx-specific roles and directives. I don't know how large the effort to do this would be, as Sphinx and Docutils are drifting apart more and more. And unnecesarily :-( Most of the sphinx directives could be hacked so they worked as addons to docutils (by creating a sphinx-rst2html or whatever and just registering the directives). I am talking about graphviz, code blocks, production lists, and others. -- 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 sphinx-dev+unsubscr...@googlegroups.comsphinx-dev%2bunsubscr...@googlegroups.com . For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- 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 sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] add_description_unit - control output?
bob84123 ama...@gmail.com writes: I've been using an extension with the following line, in order to document and catalog requirements: app.add_description_unit(directivename = 'requirement', rolename = 'req') Now I'd like to customise the output of the directive, but that's where I'm stuck. The documentation says: If you provide parse_node, it must be a function that takes a string and a docutils node, and it must populate the node with children parsed from the string. It must then return the name of the item to be used in cross-referencing and index entries. See the ext.py file in the source for this documentation for an example. Unfortunately I can't seem to find any such ext.py file anywhere, so I don't know where to start in figuring out how to use this. Can anyone help? The code has been moved into the documentation's conf.py file Florian -- Simple dict-like Python API for GConf: http://www.florian-diesch.de/software/easygconf/ -- 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 sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
