Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
H
hpvm-release
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
llvm
hpvm-release
Commits
360dd5ef
Commit
360dd5ef
authored
3 years ago
by
Yifan Zhao
Browse files
Options
Downloads
Patches
Plain Diff
Added config file for readthedocs
parent
305da94f
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
.readthedocs.yaml
+12
-0
12 additions, 0 deletions
.readthedocs.yaml
hpvm/docs/README.md
+2
-2
2 additions, 2 deletions
hpvm/docs/README.md
hpvm/docs/requirements.txt
+4
-0
4 additions, 0 deletions
hpvm/docs/requirements.txt
with
18 additions
and
2 deletions
.readthedocs.yaml
0 → 100644
+
12
−
0
View file @
360dd5ef
# .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
This diff is collapsed.
Click to expand it.
hpvm/docs/README.md
+
2
−
2
View file @
360dd5ef
...
@@ -4,10 +4,10 @@ We use Sphinx for generating the API and reference documentation.
...
@@ -4,10 +4,10 @@ We use Sphinx for generating the API and reference documentation.
## Instructions
## Instructions
Install
the following Python packages
needed to build the documentation by entering:
Install
Sphinx
needed to build the documentation by entering:
```
bash
```
bash
pip3
install
sphinx sphinx-autodoc-typehints sphinx-rtd-theme numpydoc
pip3
install
-r
requirements.txt
```
```
To build the HTML documentation, enter::
To build the HTML documentation, enter::
...
...
This diff is collapsed.
Click to expand it.
hpvm/docs/requirements.txt
0 → 100644
+
4
−
0
View file @
360dd5ef
sphinx>=3.5
sphinx-autodoc-typehints>=1.11
sphinx-rtd-theme>=0.5
numpydoc>=1.1
\ No newline at end of file
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment