Skip to content
Snippets Groups Projects
Commit 360dd5ef authored by Yifan Zhao's avatar Yifan Zhao
Browse files

Added config file for readthedocs

parent 305da94f
No related branches found
No related tags found
No related merge requests found
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
sphinx:
configuration: hpvm/docs/conf.py
python:
version: 3.6
install:
- requirements: hpvm/docs/requirements.txt
......@@ -4,10 +4,10 @@ We use Sphinx for generating the API and reference documentation.
## Instructions
Install the following Python packages needed to build the documentation by entering:
Install Sphinx needed to build the documentation by entering:
```bash
pip3 install sphinx sphinx-autodoc-typehints sphinx-rtd-theme numpydoc
pip3 install -r requirements.txt
```
To build the HTML documentation, enter::
......
sphinx>=3.5
sphinx-autodoc-typehints>=1.11
sphinx-rtd-theme>=0.5
numpydoc>=1.1
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment