Re: [sphinx-dev] Where is the Sphinx-Wiki???

2010-10-05 Thread Daniel Neuhäuser
There is no way at the moment to use a Wiki as a platform to create
documentation. We are working on a websupport library as part of Sphinx
which will be in the next version along with several other new major
features which have been developed during GSoC (don't hold your breath
just yet.)

It will allow you to create a web application which also provides
comments or proposals (changes to the documentation provided by a user.)

It would be nice to have a generic application which uses it to the full
extent and allows you to easily create and edit documents and push those
changes to a repository (git or hg, anyvc?) however that's a lot of work
and I doubt that we have either the time or manpower required to create
such a project to our satisfaction.

-- 
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] Where is the Sphinx-Wiki???

2010-10-05 Thread Kevin Dunn
Hi,

While I can appreciate that Sphinx is often used for documenting source
code, I see, and use Sphinx more as a tool for creating documents, from
scratch, that get published to multiple formats (write one, publish
anywhere).

One example of that approach is a wiki I use for teaching my classes: e.g.

* Web page: http://stats4.eng.mcmaster.ca/wiki/LVM:_class_1
* Wiki and RST code for the same page:
http://stats4.eng.mcmaster.ca/w/index.php?title=LVM:_class_1&action=edit

The site is an ordinary Mediawiki installation, but I've created a Mediawiki
extension so that any wiki text that appears between   ...   tags
is stripped out, and sent off to Sphinx to compile it to HTML.  Then that
HTML output is shown, rather than Mediawiki's rendering of the HTML.

That same RST code is used to compile (LaTeX) PDF documents for the students
to download on the site, but I could also have used the epub output format,
or whatever other output format(s) I prefer, of the same content, without
having to rewrite the RST.

Hope that helps,
Kevin

On Tue, Oct 5, 2010 at 03:39, Alastair Dent wrote:

> I think you've misunderstood the main usage of Sphinx.
>
> It is used for producing documentation from commented source code, where
> the comments are written in rst format.
>
> I'd be very interested in a project that used a wiki as a source.
>
> -Original Message-
> From: sphinx-dev@googlegroups.com [mailto:sphinx-...@googlegroups.com] On
> Behalf Of Snaky Love
> Sent: 28 September 2010 19:21
> To: sphinx-dev
> Subject: [sphinx-dev] Where is the Sphinx-Wiki???
>
> Hi, sorry for maybe asking about the most obvious thing, but I was not able
> to find anything that helped me to answer the question myself...
> so I would like to ask here: where is the sphinx wiki??? No, not a wiki
> about sphinx, I am searching a wiki that is using sphinx?
>
> You are using wikis geherating collaborative documentation projects with
> sphinx, aren´t you?
>
> Which wiki are you using?
>
> Thank you very much for your attention!
>
> Snaky
>

-- 
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] Where is the Sphinx-Wiki???

2010-10-05 Thread Alastair Dent
I think you've misunderstood the main usage of Sphinx.

It is used for producing documentation from commented source code, where the 
comments are written in rst format.

I'd be very interested in a project that used a wiki as a source. 

-Original Message-
From: sphinx-dev@googlegroups.com [mailto:sphinx-...@googlegroups.com] On 
Behalf Of Snaky Love
Sent: 28 September 2010 19:21
To: sphinx-dev
Subject: [sphinx-dev] Where is the Sphinx-Wiki???

Hi, sorry for maybe asking about the most obvious thing, but I was not able to 
find anything that helped me to answer the question myself...
so I would like to ask here: where is the sphinx wiki??? No, not a wiki 
about sphinx, I am searching a wiki that is using sphinx?

You are using wikis geherating collaborative documentation projects with 
sphinx, aren´t you?

Which wiki are you using?

Thank you very much for your attention!

Snaky

--
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.