docs: update documentation workflow to support config files (#54)

Fix spacing

Update conf.py

Update doc-gen.yml

Update doc-gen.yml

Update doc-gen.yml

Update doc-gen.yml

Update doc-gen.yml

Update conf.py

Update doc-gen.yml

Update doc-gen.yml

Update dgp.rst

Fix lint error

Update conf.py

Update doc-gen.yml

.github/workflows/doc-gen.yml

@@ -10,18 +10,23 @@ jobs:
       OS: ubuntu-18.04
       PYTHON: '3.6'
     steps:
+    - uses: actions/checkout@master
+      with:
+        fetch-depth: ‘1’
     - name: Setup Python
       uses: actions/setup-python@master
       with:
         python-version: 3.6
-    - name: Setup reqs
+    - name: Setup requirements and run sphinx
       run: |
         python -m pip install --upgrade pip
         pip install cython==0.29.21 numpy==1.19.4
-    - name: Push Sphinx Pages
-      uses: seanzhengw/sphinx-pages@master
+        pip install -r requirements.txt
+        cd docs
+        make html
+    - name: Push Sphinx Pages to Webserver
+      uses: JamesIves/[email protected]
       with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        create_readme: true
-        source_dir: ./docs/source
-        install_extensions: false
+        branch: gh-pages
+        folder: ./docs/build/html
+        commit-message: 'docs: update build documentation'

docs/source/conf.py

@@ -39,7 +39,8 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+# Currently, excludes all autogen files
+exclude_patterns = ['**/*pb2_grpc.py', '**/*_pb2.py']
 
 # -- Options for HTML output -------------------------------------------------
 

docs/source/dgp.rst

@@ -8,9 +8,7 @@ Subpackages
    :maxdepth: 4
 
    dgp.annotations
-   dgp.contribs
    dgp.datasets
-   dgp.proto
    dgp.scripts
    dgp.utils