Skip to content
This repository was archived by the owner on Jan 25, 2021. It is now read-only.

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Live docs

A live version of latest documentation is hosted at http://serrano-lib.org/docs/

Generate local docs

  1. Install mkdocs to generate guides and tutorials
$ pip install mkdocs
  1. Install realm/jazzy to generate APIs and classes reference
$ [sudo] gem install jazzy
  1. Clone repo and generate docs
$ git clone https://github.com/pcpLiu/serrano
$ cd serrano/
$ chmod u+x docs/doc_generate.sh
$ ./docs/doc_generate.sh 

The generated docs are located in docs/ folder.