Skip to content

Latest commit

 

History

History
18 lines (16 loc) · 761 Bytes

File metadata and controls

18 lines (16 loc) · 761 Bytes

How to run the docs locally

  1. (Skip this step if you have already installed hydrus)
     i) Clone the hydrus repository: git clone https://github.com/HTTP-APIs/hydrus.git
     ii) Install requirements (It is recommended to use a virtual environment)
     cd hydrus
     pip install -r requirements.txt
     iii) Install hydrus
     python setup.py install
  2. Build the docs
     cd docs
     sphinx-build -b html ./source/ ./build/html/
    HTML files are generated in the build/html folder which can be used to check the pages.

    In order to make a clean build:
     make clean
     sphinx-build -b html ./source/ ./build/html/