From 360dd5ef713d255dafde6695cf3cfc9edd401dae Mon Sep 17 00:00:00 2001 From: Yifan Zhao <yifanz16@illinois.edu> Date: Sat, 27 Mar 2021 15:13:19 -0500 Subject: [PATCH] Added config file for readthedocs --- .readthedocs.yaml | 12 ++++++++++++ hpvm/docs/README.md | 4 ++-- hpvm/docs/requirements.txt | 4 ++++ 3 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 .readthedocs.yaml create mode 100644 hpvm/docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000..71f228c97b --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,12 @@ +# .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 diff --git a/hpvm/docs/README.md b/hpvm/docs/README.md index c93b7ed151..99bcc3f7d4 100644 --- a/hpvm/docs/README.md +++ b/hpvm/docs/README.md @@ -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:: diff --git a/hpvm/docs/requirements.txt b/hpvm/docs/requirements.txt new file mode 100644 index 0000000000..3226d75e97 --- /dev/null +++ b/hpvm/docs/requirements.txt @@ -0,0 +1,4 @@ +sphinx>=3.5 +sphinx-autodoc-typehints>=1.11 +sphinx-rtd-theme>=0.5 +numpydoc>=1.1 \ No newline at end of file -- GitLab