[Skiboot] [RFC] Doc: Add support to build OpenPOWER Foundation style documentation from RST

[Jeffrey Scheel]

Stewart Smith <stewart at linux.vnet.ibm.com> wrote on 05/16/2017 11:03:23 
PM:
> Jeffrey Scheel <scheel at us.ibm.com> writes:
> > Stewart Smith <stewart at linux.vnet.ibm.com> wrote on 05/16/2017 
02:45:36 
> > AM:
> >> jscheel.ibm at gmail.com writes:
> >> > Here's a patch to build the Skibook documentation in an OpenPOWER
> >> > Foundation support (converts RST to XML to PDF and html).  It 
extends
> >> > the current build environment, doesn't replace it.
> >> >
> >> > Specific changes:
> >> > - Add new statement to ignore python build tool (.gitignore)
> >> > - Add use of rst2db-opf extension (conf.py)
> >> > - Add new configuration variables for Docbook build (conf.py)
> >> > - Add new enviornment variables to support Docbook build (Makefile)
> >> > - Add new "docbook" target (Makefile)
> >> > - Some minor cleanup (Makefile, conf.py)
> >> >
> >> > Comments, suggestions welcome!
> >> > 
> >> > Signed-off-by: Jeff Scheel <scheel at us.ibm.com>
> >> 
> >> On the whole, I don't think there's a problem carrying something like
> >> this, and hopefully it helps us get better at doing documentation and
> >> being able to publish it out and get OpenPOWER Fonudation kudos for
> >> doing so. Of course, even though we have a whole lot more docs than
> >> we've ever had before, we're not exactly flush with them, and they're
> >> certainly incomplete :/
> >> 
> >> Anyway, I gave it all a try:
> >> 
> >> I got errors with the detection of rst2db-opf and git (I wonder if 
this
> >> is because they're part of a target (I'll cry about makefile foo 
right
> >> about now).
> > So, in my previous pull request, I had the step you're missing:
> > sudo -H pip install rstdb-opf
> >
> > I suspect you didn't do this step since you're omnipotent, not
> > omniscient.
> 
> I used python virtualenv:
> 
> virtualenv ~/skiboot-opf
> ~/skiboot-opf/bin/activate
> pip install rstdb-opf
I'll take a look and see if I can re-create this issue.
-Jeff

Jeffrey J. Scheel
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ozlabs.org/pipermail/skiboot/attachments/20170517/fab6fa51/attachment.html>