Building Quickbook docs from source code in HTML format

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

Building Quickbook docs from source code in HTML format

Boost - Dev mailing list
Hello,

I'm trying to build QuickBook HTML Boost library documentation from
source code. I got *.docbook file, but there is no HTML files at all.

For example I built stacktrace library docs:
     ./b2 -a libs/stacktrace/doc/
And I didn't get any HTML, only stacktrace.docbook:
$ find
.
./doc
./doc/gcc-5.4.0
./doc/gcc-5.4.0/debug
./doc/gcc-5.4.0/debug/stacktrace.xml
./doc/gcc-5.4.0/debug/stacktrace.docbook
./doc/none
./doc/none/gcc-5.4.0
./doc/none/gcc-5.4.0/debug
./doc/none/gcc-5.4.0/debug/autodoc-xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/classboost_1_1stacktrace_1_1basic__stacktrace.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/dir_3516969ce87a02a0560c741857e33749.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/dir_c8984f1860c11f62f47abb6761e46c1e.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/combine.xslt
./doc/none/gcc-5.4.0/debug/autodoc-xml/stacktrace_2stacktrace_8hpp.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/classboost_1_1stacktrace_1_1frame.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/compound.xsd
./doc/none/gcc-5.4.0/debug/autodoc-xml/index.xsd
./doc/none/gcc-5.4.0/debug/autodoc-xml/stacktrace__fwd_8hpp.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/index.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/stacktrace_8hpp.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/namespaceboost_1_1stacktrace.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/namespaceboost_1_1stacktrace_1_1detail.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/namespaceboost.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/dir_72bdf9838375a891eaf35cbacea5f7be.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/frame__decl_8hpp.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/frame_8hpp.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml/safe__dump__to_8hpp.xml
./doc/none/gcc-5.4.0/debug/autodoc-xml.doxyfile
./doc/none/gcc-5.4.0/debug/autodoc-xml.xml-dir
./doc/none/gcc-5.4.0/debug/autodoc-xml.boostbook
./doc/none/gcc-5.4.0/debug/autodoc-xml.doxygen

But I need something like this:
http://www.boost.org/doc/libs/1_65_1/doc/html/stacktrace.html
I have used quickbook install instructions for Ubuntu:
http://www.boost.org/doc/libs/1_65_1/doc/html/quickbook/install.html#quickbook.install.linux
It looks like docbook to html conversion is required using some xsl file
but I don't know how to do it and what files are used.
There is some XSL files in boost/tools/boostbook/xsl folder but I don't
know how to use it with b2 build.

PS. I have installed xsltproc, docbook-xsl, docbook-xml packages.
$ cat ~/user-config.jam
using boostbook ;

using xsltproc ;

using boostbook
     : /usr/share/xml/docbook/stylesheet/nwalsh
     : /usr/share/xml/docbook/schema/dtd/4.2
     ;

using doxygen ;

-----
Regards,
Kolya.

_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Reply | Threaded
Open this post in threaded view
|

Re: Building Quickbook docs from source code in HTML format

Boost - Dev mailing list


On 31/10/2017 17:46, Kolya Kosenko via Boost wrote:
> Hello,
>
> I'm trying to build QuickBook HTML Boost library documentation from
> source code. I got *.docbook file, but there is no HTML files at all.

What does your Jamfile look like, and what's the b2 output when run? 
Maybe do a:

b2 -d2 -a

and report back?

John.


>
> For example I built stacktrace library docs:
>     ./b2 -a libs/stacktrace/doc/
> And I didn't get any HTML, only stacktrace.docbook:
> $ find
> .
> ./doc
> ./doc/gcc-5.4.0
> ./doc/gcc-5.4.0/debug
> ./doc/gcc-5.4.0/debug/stacktrace.xml
> ./doc/gcc-5.4.0/debug/stacktrace.docbook
> ./doc/none
> ./doc/none/gcc-5.4.0
> ./doc/none/gcc-5.4.0/debug
> ./doc/none/gcc-5.4.0/debug/autodoc-xml
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/classboost_1_1stacktrace_1_1basic__stacktrace.xml
>
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/dir_3516969ce87a02a0560c741857e33749.xml
>
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/dir_c8984f1860c11f62f47abb6761e46c1e.xml
>
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/combine.xslt
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/stacktrace_2stacktrace_8hpp.xml
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/classboost_1_1stacktrace_1_1frame.xml
>
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/compound.xsd
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/index.xsd
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/stacktrace__fwd_8hpp.xml
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/index.xml
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/stacktrace_8hpp.xml
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/namespaceboost_1_1stacktrace.xml
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/namespaceboost_1_1stacktrace_1_1detail.xml
>
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/namespaceboost.xml
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/dir_72bdf9838375a891eaf35cbacea5f7be.xml
>
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/frame__decl_8hpp.xml
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/frame_8hpp.xml
> ./doc/none/gcc-5.4.0/debug/autodoc-xml/safe__dump__to_8hpp.xml
> ./doc/none/gcc-5.4.0/debug/autodoc-xml.doxyfile
> ./doc/none/gcc-5.4.0/debug/autodoc-xml.xml-dir
> ./doc/none/gcc-5.4.0/debug/autodoc-xml.boostbook
> ./doc/none/gcc-5.4.0/debug/autodoc-xml.doxygen
>
> But I need something like this:
> http://www.boost.org/doc/libs/1_65_1/doc/html/stacktrace.html
> I have used quickbook install instructions for Ubuntu:
> http://www.boost.org/doc/libs/1_65_1/doc/html/quickbook/install.html#quickbook.install.linux
> It looks like docbook to html conversion is required using some xsl
> file but I don't know how to do it and what files are used.
> There is some XSL files in boost/tools/boostbook/xsl folder but I
> don't know how to use it with b2 build.
>
> PS. I have installed xsltproc, docbook-xsl, docbook-xml packages.
> $ cat ~/user-config.jam
> using boostbook ;
>
> using xsltproc ;
>
> using boostbook
>     : /usr/share/xml/docbook/stylesheet/nwalsh
>     : /usr/share/xml/docbook/schema/dtd/4.2
>     ;
>
> using doxygen ;
>
> -----
> Regards,
> Kolya.
>
> _______________________________________________
> Unsubscribe & other changes:
> http://lists.boost.org/mailman/listinfo.cgi/boost
>


---
This email has been checked for viruses by AVG.
http://www.avg.com


_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Reply | Threaded
Open this post in threaded view
|

Re: Building Quickbook docs from source code in HTML format

Boost - Dev mailing list
On 10/31/2017 07:53 PM, John Maddock via Boost wrote:
> What does your Jamfile look like,

I'm trying to build docs from stacktrace library from boost 1.65.1:
https://github.com/boostorg/stacktrace/blob/boost-1.65.1/doc/Jamfile.v2

> and what's the b2 output when run?
> Maybe do a:
>
> b2 -d2 -a
>
> and report back?

Output for command:
./b2 -d2 -a ./libs/stacktrace/doc/
is here:
https://justpaste.it/1d0mt

_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Reply | Threaded
Open this post in threaded view
|

Re: Building Quickbook docs from source code in HTML format

Boost - Dev mailing list

> Output for command:
> ./b2 -d2 -a ./libs/stacktrace/doc/
> is here:
> https://justpaste.it/1d0mt
>

According to that, html generation went fine and should be under
libs/stacktrace/doc/html

Works for me anyway....

HTH, John.

---
This email has been checked for viruses by AVG.
http://www.avg.com


_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Reply | Threaded
Open this post in threaded view
|

Re: Building Quickbook docs from source code in HTML format

Boost - Dev mailing list
On 10/31/2017 09:32 PM, John Maddock via Boost wrote:
> According to that, html generation went fine and should be under
> libs/stacktrace/doc/html

Yes! It works! :)))
I thought html output will be in bin.v2 directory.
Thanks a lot for your hint.

Regards,
Kolya.

_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost