Skip to content

hnikolov/pihdf_doc

Repository files navigation

pihdf_doc

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.

Install urubu

$ sudo pip install urubu

Build the website

$ make build

The resulting (html) website is located in directory _build.

Review the website

$ 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

About

The source of the pyhdf documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages