Puppet strings and Readme.md

[Albert Shih]

Hi everyone,

I try to build my documentation with strings. So for each class it's
working well. But for each module I'm unable to make strings transform the
README.md and put it some place like the root of each module.

What I'm looking is to get a « web site » (bunch of html file) with for
each module I have the README.md and every class in that module. Currently
I'm only get every class.

Regards.
--
Albert SHIH
Observatoire de Paris
xmpp: j...@obspm.fr
Heure local/Local time:
Fri Sep 21 10:40:53 CEST 2018

[Albert Shih]

Le 21/09/2018 à 10:43:12+0200, Albert Shih a écrit

> Hi everyone,
>
> I try to build my documentation with strings. So for each class it's
> working well. But for each module I'm unable to make strings transform the
> README.md and put it some place like the root of each module.
>
> What I'm looking is to get a « web site » (bunch of html file) with for
> each module I have the README.md and every class in that module. Currently
> I'm only get every class.

Well, my question isn't very clear.

So how can I generated in static html the exact *SAME* website as

puppet strings server --modulepath modules/

does ?

Regards.
--
Albert SHIH
Observatoire de Paris
xmpp: j...@obspm.fr
Heure local/Local time:

Fri Sep 21 15:08:40 CEST 2018

[David Mallon]

Hi Albert, were you able to follow the steps in the documentation for generating HTML? 

--
You received this message because you are subscribed to the Google Groups "Puppet Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-users+unsubscribe@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/puppet-users/20180921084312.GA1622%40io.chezmoi.fr.
For more options, visit https://groups.google.com/d/optout.

[Albert Shih]

Le 21/09/2018 à 11:08:29+0100, David Mallon a écrit
Hi,

> Hi Albert, were you able to follow the steps in the documentation for
> generating HTML? 

Absolutly.

I can generate a pretty good html with

puppet string generate modules/*

But it's different than

puppet string server --modulepath modules

With the first sentence I get a list of file but without the README.md of
each modules, « just » each class.

With the second I get a TOC of each module, and in each module I get the
README.md (convert to HTML), something very similar to

https://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md

Maybe (well ok not maybe, it's sure ;-) ) I do something wrong but when I'm
using puppet strings generate it's seem I loose a « level ».

Regards

--
Albert SHIH
DIO bâtiment 15

Observatoire de Paris
xmpp: j...@obspm.fr
Heure local/Local time:

Fri Sep 21 23:02:49 CEST 2018