Re: Sphinx for general use
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've barely scratched the surface of using it though. So, I'm considering using it to make a lab manual to document all sorts of things we do, mostly NOT related to Python. I like the idea that one document can serve both as an on-line resource, and as a printed book. What, if anything, ties Sphinx to documenting Python projects, or does it just _facilitate_ that? As Sebastian said, Python is its origin and focus, but there's nothing that prevents you from not documenting something Python. q§ Just to add my bit: I am considering to use Sphinx for setting up a web-page that is not documenting a software project or code, but rather represents some more generic kind of webpage (for example for a research group). I have played with rest2www before (and use this for http://www.soton.ac.uk/~fangohr for example), and am currently trying to understand what I can and can't do with sphinx for these kind of applications. (All I need are static webpages, so I didn't go down the Django route yet). If people can recommend any other tools that are similar to rest2www and 'sphinx for generic webpages', I'd be interested about that. I know of one generic personal webpage that's made with Sphinx: http://lunaryorn.de/ FWIW, the Sphinx 0.5 sources of the site are available online at http://git.lunaryorn.de/?p=lunarsite;a=summary Hih -- Freedom is always the freedom of dissenters. (Rosa Luxemburg) signature.asc Description: This is a digitally signed message part.
Re: Sphinx for general use
On Thu, Nov 6, 2008 at 9:45 PM, Roger Binns [EMAIL PROTECTED] wrote: Alaric Haag wrote: So, I'm considering using it to make a lab manual to document all sorts of things we do, mostly NOT related to Python. I like the idea that one document can serve both as an on-line resource, and as a printed book. You should also strongly consider a wiki as that allows anyone to update the content and doesn't require a central gatekeeper(*). Most wikis have some sort of extension for producing a PDF. If you like the rst syntax then it looks like Trac can work with it. Does Trac have an extension for producing a PDF? I haven't heard of one. If one of Alaric's requirements is to have a printed book, then that would be a downside to using Trac. I found several mailing list messages about using Sphinx with Trac but couldn't quite work out what they were trying to achieve. I haven't seen the threads in question, but it may be that they were trying to use the ReST macro in Trac to display ReST files that are stored in SVN, while also using those files with Sphinx. The trick is that inter-file references work differently in those two cases. This scenario is less wiki-ish, in that you need SVN commit permission to edit the content. (*) Other people have the opinion that good documentation can only be produced by a central expert and gatekeeper. Wikipedia is counter evidence ... True, but even wikis need somebody to be responsible for maintaining structure and consistency. These people may be self-appointed (as for Wikipedia) if the user base is large enough. But for a small user base like a lab, such a person needs to be explicitly designated. --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 [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Re: Sphinx for general use
Janet Swisher wrote: Does Trac have an extension for producing a PDF? I haven't heard of one. There are several. This is is one example: http://trac-hacks.org/wiki/CombineWikiPlugin But for a small user base like a lab, such a person needs to be explicitly designated. I would argue that depends on group culture :-) Roger --~--~-~--~~~---~--~~ 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 [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Re: Sphinx for general use
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've barely scratched the surface of using it though. So, I'm considering using it to make a lab manual to document all sorts of things we do, mostly NOT related to Python. I like the idea that one document can serve both as an on-line resource, and as a printed book. What, if anything, ties Sphinx to documenting Python projects, or does it just _facilitate_ that? As Sebastian said, Python is its origin and focus, but there's nothing that prevents you from not documenting something Python. I've updated the website to reflect that. (When I'd written that, I had not assumed the rather quick success... ;) Georg --~--~-~--~~~---~--~~ 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 [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Re: Sphinx for general use
On Nov 6, 3:39 am, Georg Brandl [EMAIL PROTECTED] wrote: 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've barely scratched the surface of using it though. So, I'm considering using it to make a lab manual to document all sorts of things we do, mostly NOT related to Python. I like the idea that one document can serve both as an on-line resource, and as a printed book. What, if anything, ties Sphinx to documenting Python projects, or does it just _facilitate_ that? As Sebastian said, Python is its origin and focus, but there's nothing that prevents you from not documenting something Python. I've updated the website to reflect that. (When I'd written that, I had not assumed the rather quick success... ;) Georg Many thanks, and congrats on that success! It looks to be a great tool, and I look forward to digging into it! Cheers, Alaric --~--~-~--~~~---~--~~ 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 [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
Sphinx for general use
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 make a lab manual to document all sorts of things we do, mostly NOT related to Python. I like the idea that one document can serve both as an on-line resource, and as a printed book. What, if anything, ties Sphinx to documenting Python projects, or does it just _facilitate_ that? Many thanks! Alaric --~--~-~--~~~---~--~~ 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 [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
