Quantcast

RFC pod2rst docs changes

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

RFC pod2rst docs changes

Jeff Fearn
Hi, using RST bugs me and having the docs split between two UIs bugs me,
the solution, pod2rst.

Attached is a patch to replace the current pod2html with pod2rst, it's
incomplete as I'm not sure exactly where to put the rst files or how
best to integrate the docs in to the rest of the ... rest :D

Currently they get put in to docs/$lang/intergration/api/ and get added
to the bottom of the integrating docs.

https://jfearn.fedorapeople.org/bz5-docs-test/integrating/index.html

Note the poor choice of title for this section ^_^

I copied a couple of extensions in to the upstream 5.0 branch just for
demonstration.

I note that none of the extensions get added to the search, going to
have to figure that one out.

It'd be nice to put the WebServer docs in to the API docs, but should
they go in both places?

It's also be nice if we had a standard way of doing User and admin docs
in the extension pod, and putting that in the right guide.

Say Extension.pm has the user docs and lib/Config.pm has the admin docs,
or something.

What I like about that is all the information would be available both in
the POD and in the web docs, so you could always find all the docs.

Comments welcome ;)

Cheers, Jeff.

-
To view or change your list settings, click here:
<https://lists.bugzilla.org/cgi-bin/mj_wwwusr?user=lists+s6506n84121h51@...>

pod2rst.patch (5K) Download Attachment
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: RFC pod2rst docs changes

Jeff Fearn
On 6/09/2016 17:08, Jeff Fearn wrote:

> Hi, using RST bugs me and having the docs split between two UIs bugs me,
> the solution, pod2rst.
>
> Attached is a patch to replace the current pod2html with pod2rst, it's
> incomplete as I'm not sure exactly where to put the rst files or how
> best to integrate the docs in to the rest of the ... rest :D
>
> Currently they get put in to docs/$lang/intergration/api/ and get added
> to the bottom of the integrating docs.
>
> https://jfearn.fedorapeople.org/bz5-docs-test/integrating/index.html
>
> Note the poor choice of title for this section ^_^
>
> I copied a couple of extensions in to the upstream 5.0 branch just for
> demonstration.
>
> I note that none of the extensions get added to the search, going to
> have to figure that one out.
>
> It'd be nice to put the WebServer docs in to the API docs, but should
> they go in both places?
>
> It's also be nice if we had a standard way of doing User and admin docs
> in the extension pod, and putting that in the right guide.
>
> Say Extension.pm has the user docs and lib/Config.pm has the admin docs,
> or something.
>
> What I like about that is all the information would be available both in
> the POD and in the web docs, so you could always find all the docs.
>
> Comments welcome ;)
>
> Cheers, Jeff.
>

A dingo ate my patch :(

https://jfearn.fedorapeople.org/bz5-docs-test/docs.patch

Cheers, Jeff.

-
To view or change your list settings, click here:
<https://lists.bugzilla.org/cgi-bin/mj_wwwusr?user=lists+s6506n84121h51@...>
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: RFC pod2rst docs changes

Gervase Markham
In reply to this post by Jeff Fearn
On 06/09/16 08:08, Jeff Fearn wrote:
> Attached is a patch to replace the current pod2html with pod2rst, it's
> incomplete as I'm not sure exactly where to put the rst files or how
> best to integrate the docs in to the rest of the ... rest :D

Still, this is an awesome idea. Thank you for doing it!

Gerv


_______________________________________________
dev-apps-bugzilla mailing list
[hidden email]
https://lists.mozilla.org/listinfo/dev-apps-bugzilla
-
To view or change your list settings, click here:
<https://lists.bugzilla.org/cgi-bin/mj_wwwusr?user=lists+s6506n84121h51@...>
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: RFC pod2rst docs changes

Gervase Markham
In reply to this post by Jeff Fearn
On 07/09/16 02:11, Jeff Fearn wrote:
> A dingo ate my patch :(
>
> https://jfearn.fedorapeople.org/bz5-docs-test/docs.patch

Hey Jeff,

I'm keen to make sure this doesn't get lost. Can you file a bug, attach
the patch and CC me? :-)

Gerv
_______________________________________________
dev-apps-bugzilla mailing list
[hidden email]
https://lists.mozilla.org/listinfo/dev-apps-bugzilla
-
To view or change your list settings, click here:
<https://lists.bugzilla.org/cgi-bin/mj_wwwusr?user=lists+s6506n84121h51@...>
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: RFC pod2rst docs changes

Jeff Fearn
On 26/10/16 20:54, Gervase Markham wrote:
> On 07/09/16 02:11, Jeff Fearn wrote:
>> A dingo ate my patch :(
>>
>> https://jfearn.fedorapeople.org/bz5-docs-test/docs.patch
>
> Hey Jeff,
>
> I'm keen to make sure this doesn't get lost. Can you file a bug, attach
> the patch and CC me? :-)

I'll open a bug. Matt fixed a bug with the links to CPAN modules so I'll
include that.

I'll just have to port it to master as it's done on our 5.0 branch.

Cheers, Jeff.


signature.asc (484 bytes) Download Attachment
Loading...