Add docs to the contrib repo

open-telemetry · Dec 11, 2020 · 6ccc2f4 · 6ccc2f4
1 parent 91bfc9a
commit 6ccc2f4
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,14 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+sphinx:
+  configuration: docs/conf.py
+
+build:
+  image: latest
+
+python:
+  version: 3.9
+  install:
+    - requirements: docs-requirements.txt
diff --git a/docs-requirements.txt b/docs-requirements.txt
diff --git a/tox.ini b/tox.ini
@@ -136,6 +136,7 @@ envlist =
 
     lint
     docker-tests
+    docs
 
 [testenv]
 deps =
@@ -273,6 +274,16 @@ commands =
   test: pytest {posargs}
   coverage: {toxinidir}/scripts/coverage.sh
 
+[testenv:docs]
+deps =
+  -c {toxinidir}/dev-requirements.txt
+  -r {toxinidir}/docs-requirements.txt
+
+changedir = docs
+
+commands =
+  sphinx-build -E -a -W -b html -T . _build/html
+
 [testenv:lint]
 basepython: python3.8
 recreate = True