Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 984 Bytes

README.md

File metadata and controls

36 lines (25 loc) · 984 Bytes
Raw

cyphyhouse.rtfd.io

License

This repository is for automatically generating software documentation website for CyPhyHouse project on Read the Docs hosting service.

To read the generated documentation, please visit https://cyphyhouse.rtfd.io

Build the website locally

Building this documentation website locally requires Python 3 and pip. With Python and pip, please run the command below to install the required Python packages:

$ pip install -U -r requirements.txt

After the packages are installed, simply run the following command to build the web pages:

$ make html

The generated web pages will be stored under build\html folder.

License

cyphyhouse.rtfd.io is licensed under the terms of the NCSA License (see the file LICENSE).