Merge pull request #283 from mavlink/pr-fix-docs

Fix docs
mavlink · Nov 4, 2020 · 2de2310 · 2de2310
2 parents 22749aa + 105cddc
commit 2de2310
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 2 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -30,7 +30,7 @@ jobs:
 
       - name: Install prerequisites
         run: |
-          pip3 install -r requirements.txt -r requirements-dev.txt
+          pip3 install -r requirements.txt -r requirements-dev.txt -r requirements-docs.txt
           pip3 install auditwheel twine
 
       - name: Create wheel
@@ -44,6 +44,11 @@ jobs:
         run: |
           ls -lh "wheelhouse/"
 
+      - name: Create docs
+        run: |
+          export PATH=$PATH:$HOME/.local/bin
+          make -C mavsdk html
+
       - name: Upload to PyPi
         env:
           TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
@@ -54,6 +59,17 @@ jobs:
           export PATH=$PATH:$HOME/.local/bin
           twine upload wheelhouse/*.whl
 
+      - name: Upload docs
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          export PATH=$PATH:$HOME/.local/bin
+          other/tools/upload_docs.sh
+
+
+
   ubuntu20-other:
     name: Ubuntu 20.04 ${{ matrix.arch }}
     runs-on: ubuntu-20.04

diff --git a/README.md b/README.md
@@ -110,7 +110,7 @@ Note: MAVDSK-Python runs `mavsdk/bin/mavsdk_server` when `await drone.connect()`
 Make sure the version tag is set correctly before generating new documentation.
 
 ```
-pip3 install sphinx numpydoc
+pip3 install -r requirements-docs.txt
 make -C mavsdk html
 ```
 

diff --git a/mavsdk/source/conf.py b/mavsdk/source/conf.py
@@ -59,3 +59,5 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['nature_adapted/static']
+
+html_favicon = "nature_adapted/static/favicon.png"
diff --git a/mavsdk/source/nature_adapted/static/favicon.png b/mavsdk/source/nature_adapted/static/favicon.png
diff --git a/other/tools/upload_docs.sh b/other/tools/upload_docs.sh
@@ -15,6 +15,10 @@ s3cmd put -m text/javascript mavsdk/build/html/_static/doctools.js s3://mavsdk-p
 s3cmd put -m text/javascript mavsdk/build/html/_static/underscore.js s3://mavsdk-python-docs/_static/
 s3cmd put -m text/javascript mavsdk/build/html/_static/documentation_options.js s3://mavsdk-python-docs/_static/
 s3cmd put -m text/javascript mavsdk/build/html/_static/language_data.js s3://mavsdk-python-docs/_static/
+s3cmd put -m text/css mavsdk/build/html/_static/nature.css s3://mavsdk-python-docs/_static/
+s3cmd put -m text/css mavsdk/build/html/_static/basic.css s3://mavsdk-python-docs/_static/
+
+s3cmd put -m image/x-icon mavsdk/build/html/_static/favicon.png s3://mavsdk-python-docs/
 
 # Set it all to public
 s3cmd setacl -r s3://mavsdk-python-docs --acl-public
diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -0,0 +1,2 @@
+sphinx>=3.3.0
+numpydoc>=1.1.0