can I use sphinx as wiki?

[Renato Pontefice]

Hi,

I would start to use a wiki to write documentation on my softwarehouse.

My Idea is to use restructuredtex, because is most useful (I can translate it on pdf, word etc...)

So my wiki reference is moinmoin. 

I saw that moinmoin is quite at release 2, but still release 1.9.x

My question is:

Could Sphinx be a wiki?

Or, it is lust a "trasformation" software?

I hope I was clear

TIA

Renato

[gilberto dos santos alves]

yes. see [1]

[1] http://adessowiki.fee.unicamp.br/adesso/

--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
To post to this group, send email to sphinx...@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

--

gilberto dos santos alves
+55(11)9-8646-5049
sao paulo - sp - brasil

[Chris Barker - NOAA Federal]

No, Sphinx is not a wiki system.

The defining feature of a wiki is that users can edit the pages on the fly in the same web app that is presenting the pages. Sphinx generates static content, and does not provide an interface for editing it.

That being said, it may be useful for your use-case.

If you put your Sphinx content in a gitHub repo, you can serve up the rendered html with gitHub pages, and your users/contributors can edit the content with gitHub's interface, OR by cloning the repo and doing the usual PR dance that is used for code.

If your contributors are fairly sophisticated or used to the gitHub workflow, this can work well.

Alternatively, there may well be a wiki system that allows RST as the markup language -- maybe even gitHub's wiki.

-CHB

--

[Chris Barker]

On Mon, May 9, 2016 at 1:05 PM, gilberto dos santos alves <gsa...@gmail.com> wrote:

yes. see [1]

[1] http://adessowiki.fee.unicamp.br/adesso/

nice! Is that using Sphinx under the hood? Or just RST with its own rendering engine?

-CHB

--

Christopher Barker, Ph.D.
Oceanographer

Emergency Response Division
NOAA/NOS/OR&R            (206) 526-6959   voice
7600 Sand Point Way NE   (206) 526-6329   fax
Seattle, WA  98115       (206) 526-6317   main reception

Chris....@noaa.gov

[gilberto dos santos alves]

using sphinx to rendering rst (app docs, samples, etc) and wiki for  make things easy.

[Peter Burdine]

If you haven't tried it, you might want to look at the sphinx-autobuild extension.  It seems to work pretty well, it will start up its own webserver and issue an html rebuild anytime a file is modified.

I have noticed though if you use the sphinx-jinja extension, changing the source of the context will trigger a rebuild, but won't necessarily rebuild the affected content.  You can make one small tweak to the plugin, change 'html' in the setup function to say 'env', then it works as expected.

If you don't have too many people, you may be able to use that as a wiki.

[gilberto dos santos alves]

hhuumm!! good information. please have one url for all of us see more details? regards.

[Derek]

https://github.com/phiggins42/rstwiki  works with reStructuredText and there seems to be support in moinmoin for it as well - https://moinmo.in/HelpOnParsers/ReStructuredText

[Renato Pontefice]

What is the differene between this wiki and moinmoikn?

Renato

[Peter Burdine]

sphinx-autobuild is at https://github.com/GaretJax/sphinx-autobuild

I haven't looked at those wiki's, but it would be wise to check if you are using sphinx specific tags that are not part of reST or if you are using any extensions.  Those may not work if you are using a reST based wiki.