Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation build to Github Actions #9569

Merged
merged 4 commits into from
Apr 20, 2020
Merged

Add documentation build to Github Actions #9569

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
98bd454
Add documentation build to Github Actions
Apr 17, 2020
101d138
Update requirements for documentation builds
Apr 17, 2020
fb3f2ba
Minor optimization - only install requirements for documentation in d…
Apr 20, 2020
822a16a
Merge branch 'master' into wbarrett/add-doctests-to-ci
Apr 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/bashlib.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ pip-install() {
say "::group::Install Python pacakges"
pip install -r requirements.txt
pip install -r requirements-dev.txt
pip install -r docs/requirements.txt
pip install -e ".[postgres,mysql]"
say "::endgroup::"

Expand Down
19 changes: 19 additions & 0 deletions .github/workflows/superset-python.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,25 @@ jobs:
# `-j 0` run Pylint in parallel
run: pylint -j 0 superset

docs:
runs-on: ubuntu-18.04
strategy:
matrix:
python-version: [3.6]
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v1
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
uses: apache-superset/cached-dependencies@adc6f73
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can move pip install -r docs/requirements.txt here:

    - name: Install dependencies
      uses: apache-superset/cached-dependencies@adc6f73
      with:
        run: |
          pip-install
          pip install -r docs/requirements.txt

Probably save a couple of seconds for other jobs.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

- name: Copy Images
run: cp -r superset-frontend/images/ docs/_static/images/
- name: Build documentation
run: sphinx-build -b html docs _build/html -W

test-postgres:
runs-on: ubuntu-18.04
strategy:
Expand Down
4 changes: 2 additions & 2 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
sphinx==2.1.2
sphinx_autodoc_typehints==1.6.0
sphinx==3.0.1
sphinx_autodoc_typehints==1.10.3
sphinx-rtd-theme==0.4.3