Discussion:
[Docutils-users] rst for library doc
Renato Pontefice
2016-02-13 13:53:42 UTC
Permalink
Hi,
I'm still looking for "the best" way to build a documentation of the
procedure program I use.

I'm very inrested in .rst. Because of the way to produce HTML and .pdf
output.
But I still need a way to built docs, by more people. so I need (I think) a
wiki as a container of that doc.

Can someone sudgest me a way?

TIA

Renato
Chris Green
2016-02-13 14:46:08 UTC
Permalink
Post by Renato Pontefice
Hi,
I'm still looking for "the best" way to build a documentation of the
procedure program I use.
I'm very inrested in .rst. Because of the way to produce HTML and .pdf
output.
But I still need a way to built docs, by more people. so I need (I
think) a wiki as a container of that doc.
Can someone sudgest me a way?
There are several wikis which can work with RST, a quick Google search
will turn up a few.

I have written an RST plugin for Dokuwiki which is an excellent wiki
for documentation.
--
Chris Green

------------------------------------------------------------------------------
Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
_______________________________________________
Docutils-users mailing list
Docutils-***@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/docutils-users

Please use "Reply All" to reply to the list.
renato
2016-02-13 15:34:29 UTC
Permalink
Ok, I 've seen it. It seem very intresting. It has all the thing that
I'm looking for. Now, I've to try it and try to write  .rst and export
on html and pdf.
Are there some sandbox that I can proof?

Renato
Post by Chris Green
   Hi,
   I'm still looking for "the best" way to build a documentation of
the
   procedure program I use.
   I'm very inrested in .rst. Because of the way to produce HTML
and .pdf
   output.
   But I still need a way to built docs, by more people. so I need
(I
   think) a wiki as a container of that doc.
   Can someone sudgest me a way?
There are several wikis which can work with RST, a quick Google search
will turn up a few.
I have written an RST plugin for Dokuwiki which is an excellent wiki
for documentation.
Chris Green
2016-02-13 15:55:28 UTC
Permalink
Post by renato
Post by Chris Green
   Hi,
   I'm still looking for "the best" way to build a documentation of
the
   procedure program I use.
   I'm very inrested in .rst. Because of the way to produce HTML
and .pdf
   output.
   But I still need a way to built docs, by more people. so I need
(I
   think) a wiki as a container of that doc.
   Can someone sudgest me a way?
There are several wikis which can work with RST, a quick Google search
will turn up a few.
I have written an RST plugin for Dokuwiki which is an excellent wiki
for documentation.
Ok, I 've seen it. It seem very intresting. It has all the thing that
I'm looking for. Now, I've to try it and try to write  .rst and export
on html and pdf.
Are there some sandbox that I can proof?
Dokuwiki is quite simple to install if you have a server of your own,
alternatively a lot of hosting providers have it as a standard web
application to install from the control panel.

A basic Dokuwiki installation comes with a 'playground' area which is
a place to try things out.

... even better, the Dokuwiki home has a playground page:-

https://www.dokuwiki.org/playground
--
Chris Green

------------------------------------------------------------------------------
Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
_______________________________________________
Docutils-users mailing list
Docutils-***@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/docutils-users

Please use "Reply All" to reply to the list.
Renato Pontefice
2016-02-15 09:58:16 UTC
Permalink
There are several wikis which can work with RST, a quick Google search
Post by Chris Green
will turn up a few.
I have written an RST plugin for Dokuwiki which is an excellent wiki
for documentation.
--
Chris Green
Hi Chris, is this you plugin?
Post by Chris Green
rst Plugin by chrsibsd
I've just seen and installed DW. I need to learn it a bit.
Post by Chris Green
------------------------------------------------------------------------------
Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
_______________________________________________
Docutils-users mailing list
https://lists.sourceforge.net/lists/listinfo/docutils-users
Please use "Reply All" to reply to the list.
Chris Green
2016-02-15 10:03:15 UTC
Permalink
Post by Chris Green
There are several wikis which can work with RST, a quick Google search
will turn up a few.
I have written an RST plugin for Dokuwiki which is an excellent wiki
for documentation.
--
Chris Green
Hi Chris, is this you plugin?
rst Plugin by chrsibsd
I've just seen and installed DW. I need to learn it a bit.
Yes, that's my plugin. It's very simple, just uses the Docutils
utilities to do the actual conversion from RST to HTML. All my plugin
does is hook the conversion into Docuwiki.
--
Chris Green

------------------------------------------------------------------------------
Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
_______________________________________________
Docutils-users mailing list
Docutils-***@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/docutils-users

Please use "Reply All" to reply to the list.
Renato Pontefice
2016-02-15 10:15:00 UTC
Permalink
where do can I look for ocumentation?

Renato
Post by Chris Green
Post by Chris Green
There are several wikis which can work with RST, a quick Google search
will turn up a few.
I have written an RST plugin for Dokuwiki which is an excellent wiki
for documentation.
--
Chris Green
Hi Chris, is this you plugin?
rst Plugin by chrsibsd
I've just seen and installed DW. I need to learn it a bit.
Yes, that's my plugin. It's very simple, just uses the Docutils
utilities to do the actual conversion from RST to HTML. All my plugin
does is hook the conversion into Docuwiki.
--
Chris Green
------------------------------------------------------------------------------
Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
_______________________________________________
Docutils-users mailing list
https://lists.sourceforge.net/lists/listinfo/docutils-users
Please use "Reply All" to reply to the list.
Chris Green
2016-02-15 10:38:52 UTC
Permalink
Post by Renato Pontefice
where do can I look for ocumentation?
Renato
It's not very extensive (it's a very simple plugin), but it's here:-

https://www.dokuwiki.org/plugin:rst
--
Chris Green

------------------------------------------------------------------------------
Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
_______________________________________________
Docutils-users mailing list
Docutils-***@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/docutils-users

Please use "Reply All" to reply to the list.
Renato Pontefice
2016-02-16 09:30:06 UTC
Permalink
Hi, I'm little bit confused...I thought that I can use the normal wiki
function, and finaly export varrious page as .rst (then use the .rst to
create .pdf or HTML by rst2pdf or rst2html macro).IT seems that it is not
the way. I need to create a new link as a .rst page.
Is this the way? Or do I made some mistake?

Renato
Post by Chris Green
Post by Renato Pontefice
where do can I look for ocumentation?
Renato
It's not very extensive (it's a very simple plugin), but it's here:-
https://www.dokuwiki.org/plugin:rst
--
Chris Green
------------------------------------------------------------------------------
Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
_______________________________________________
Docutils-users mailing list
https://lists.sourceforge.net/lists/listinfo/docutils-users
Please use "Reply All" to reply to the list.
Chris Green
2016-02-16 10:57:04 UTC
Permalink
Post by Renato Pontefice
Hi, I'm little bit confused...I thought that I can use the normal wiki
function, and finaly export varrious page as .rst (then use the .rst to
create .pdf or HTML by rst2pdf or rst2html macro).IT seems that it is
not the way. I need to create a new link as a .rst page.
Is this the way? Or do I made some mistake?
You just create pages in the Wiki and access them as a Wiki, there's
no explicit exporting involved the pages are generated dynamically by
the Dokuwiki 'engine'.

So, if it's an ordinary Dokuwiki syntax page the Dokuwiki engine
converts it from Dokuwiki syntax to HTML for the web server to send.
If it's some RST then the Dokuwiki engine passes it to my RST plugin
which converts it to HTML for the web server.

You can either embed RST in a normal Dokuwiki page using the <rst> and
</rst> directives or you can create pages with .rst as a suffix and
the whole page will be treated as RST.

So my RST plugin just provides a way to write your wiki pages in a
different mark-up language from the default Dokuwiki markup, they are
still Wiki pages just liek the rest of your wiki.
--
Chris Green

------------------------------------------------------------------------------
Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
_______________________________________________
Docutils-users mailing list
Docutils-***@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/docutils-users

Please use "Reply All" to reply to the list.
Renato Pontefice
2016-02-16 11:23:02 UTC
Permalink
thank you Chris,
maybe I've found another solution;: I've installed a dokuwiki pluginm, that
let me export the entir Wiki, as a .pdf. So, with the regular Dokuwiki
formatting, I can have either the wiki and the pdf.
I've considered .rst just to be able to produce html and pdf from the same
source. Maybe this way could work

Renato
Post by Chris Green
Post by Renato Pontefice
Hi, I'm little bit confused...I thought that I can use the normal wiki
function, and finaly export varrious page as .rst (then use the .rst
to
Post by Renato Pontefice
create .pdf or HTML by rst2pdf or rst2html macro).IT seems that it is
not the way. I need to create a new link as a .rst page.
Is this the way? Or do I made some mistake?
You just create pages in the Wiki and access them as a Wiki, there's
no explicit exporting involved the pages are generated dynamically by
the Dokuwiki 'engine'.
So, if it's an ordinary Dokuwiki syntax page the Dokuwiki engine
converts it from Dokuwiki syntax to HTML for the web server to send.
If it's some RST then the Dokuwiki engine passes it to my RST plugin
which converts it to HTML for the web server.
You can either embed RST in a normal Dokuwiki page using the <rst> and
</rst> directives or you can create pages with .rst as a suffix and
the whole page will be treated as RST.
So my RST plugin just provides a way to write your wiki pages in a
different mark-up language from the default Dokuwiki markup, they are
still Wiki pages just liek the rest of your wiki.
--
Chris Green
------------------------------------------------------------------------------
Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
_______________________________________________
Docutils-users mailing list
https://lists.sourceforge.net/lists/listinfo/docutils-users
Please use "Reply All" to reply to the list.
Guenter Milde
2016-02-13 19:21:10 UTC
Permalink
Post by Renato Pontefice
Hi,
I'm still looking for "the best" way to build a documentation of the
procedure program I use.
I'm very inrested in .rst. Because of the way to produce HTML and .pdf
output.
But I still need a way to built docs, by more people. so I need (I think) a
wiki as a container of that doc.
Alternatively, you might consider putting the rst-source under version
control. To me, this seems the easiest solution in case the program itself
is under version control and the programmers are the same people that also
should be able to work on the documentation, at least.

Günter


------------------------------------------------------------------------------
Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
_______________________________________________
Docutils-users mailing list
Docutils-***@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/docutils-users

Please use "Reply All" to reply to th
Loading...