802: Document build on RHEL8 CentOS8

Summary

This note introduces additional configuration to build documentation of PG-Strom from the source.

Problems

PG-Strom manages its documentation source using markdown format. Mkdocs enables to transform the document source to regular HTML form, however, mkdocs is not provided in the RHEL8/CentOS8 packaging system based on RPM. So, we have to set up some additional software out of RPM packages.

Solution

mkdocs is implemented using Python, and it has own packaging mechanism called pip. On RHEL8/CentOS8, python3-pip package provides the installer.

$ sudo dnf install python3-pip

Then, install the latest mkdocs package using pip3.

$ sudo pip3 install mkdocs

Once mkdocs is successfully installed, you can run make mkdocs in the PG-Strom source directory.

[kaigai@namazu pg-strom]$ make docs
      :
[kaigai@namazu pg-strom]$ ls docs/
404.html   custom.css  img         operations    ref_sqlfuncs  sitemap.xml
arrow_fdw  custom_en   index.html  partition     ref_types     sitemap.xml.gz
blob       custom_ja   install     plcuda        release_note  ssd2gpu
brin       fonts       ja          ref_devfuncs  search        sys_admin
css        gstore_fdw  js          ref_params    search.html   troubles

For the folks who want to contribute documentation stuff, all the documentation sources are in the <PG-STROM>/man/ directory. The contents of <PG-STROM>/docs and <PG-STROM>/docs/ja are automatically generated by mkdocs.

Changelog

• Last-update: 31st-Dec-2019
• Author: KaiGai Kohei
• OS: RHEL8/CentOS8