Build and host docs via github action (open-telemetry#167)

c24t · web-flow · commit 81cd8d616e9b · 2019-09-25T14:41:03.000-07:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,23 @@
+name: Docs
+
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-python@v1
+    - name: Build docs
+      run: |
+        pip install --upgrade tox
+        tox -e docs
+    - name: Publish to gh-pages
+      uses: JamesIves/github-pages-deploy-action@2.0.2
+      env:
+        ACCESS_TOKEN: ${{ secrets.DocsPushToken }}
+        BRANCH: gh-pages
+        FOLDER: docs/_build/html/
diff --git a/docs/conf.py b/docs/conf.py
@@ -42,6 +42,9 @@
     "sphinx.ext.viewcode",
     # Link to other sphinx docs
     "sphinx.ext.intersphinx",
+    # Add a .nojekyll file to the generated HTML docs
+    # https://help.github.com/en/articles/files-that-start-with-an-underscore-are-missing
+    "sphinx.ext.githubpages",
 ]
 
 intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,9 @@`
`42`	`42`	`"sphinx.ext.viewcode",`
`43`	`43`	`# Link to other sphinx docs`
`44`	`44`	`"sphinx.ext.intersphinx",`
	`45`	`+ # Add a .nojekyll file to the generated HTML docs`
	`46`	`+ # https://help.github.com/en/articles/files-that-start-with-an-underscore-are-missing`
	`47`	`+ "sphinx.ext.githubpages",`
`45`	`48`	`]`
`46`	`49`
`47`	`50`	`intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}`