From 998feae0470185fab0f2fec7db7b2e116ead23bc Mon Sep 17 00:00:00 2001 From: sshusainTRI <92397275+sshusainTRI@users.noreply.github.com> Date: Fri, 12 Nov 2021 14:18:56 -0500 Subject: [PATCH] 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 | 19 ++++++++++++------- docs/source/conf.py | 3 ++- docs/source/dgp.rst | 2 -- 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/.github/workflows/doc-gen.yml b/.github/workflows/doc-gen.yml index ac8ffd11..6ed3a542 100644 --- a/.github/workflows/doc-gen.yml +++ b/.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/github-pages-deploy-action@4.1.5 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' diff --git a/docs/source/conf.py b/docs/source/conf.py index dc23d042..bf3fb14e 100644 --- a/docs/source/conf.py +++ b/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 ------------------------------------------------- diff --git a/docs/source/dgp.rst b/docs/source/dgp.rst index bc205be0..169b0e72 100644 --- a/docs/source/dgp.rst +++ b/docs/source/dgp.rst @@ -8,9 +8,7 @@ Subpackages :maxdepth: 4 dgp.annotations - dgp.contribs dgp.datasets - dgp.proto dgp.scripts dgp.utils