2.10. Build the documentation
You don’t need to depend on GitHub.
For a quick and dirty build, install Asciidoctor however you like and build:
asciidoctor README.adoc xdg-open README.html
For development, you will want to do a more controlled build with extra error checking as follows.
TODO: get this working seamlessly on Docker. For now some quick instructions for host building. For the initial build, first install RVM and Ruby as per https://www.rvm.io/rvm/install:
\curl -sSL https://get.rvm.io | bash rvm install 3.2.3
The TODO Docker instructions which are not yet working should look simply something like this:
./run-docker ./build --download-dependencies doc
which also downloads build dependencies.
Then the following times just to the faster:
./build-doc
Source: build-doc
The HTML output is located at:
xdg-open out/README.html
More information about our documentation internals can be found at: Section 38.5, “Documentation”