This repo contains the documentation of pihdf
(https://github.com/hnikolov/pihdf). The sources are in a markdown format and we use Urubu to convert them to a static website.
$ sudo pip install urubu
$ make build
The resulting (html) website is located in directory _build
.
$ make serve
and point your browser to localhost:8000/pihdf_doc/
The target website is hosted by github pages
. Therefore, the website needs to be built with the prefix pihdf_doc
(the name of this repo). Consequently, to review the generated website locally, you need to specify the prefix. Unfortunately, the pyhton built-in server does not support prefix. Therefore, the serve
target uses T-Service:
$ tserve --prefix pihdf_doc _build
Install T-Service
$ sudo pip install tservice