Skip to content

Commit

Permalink
Gitpod no doc build and no prebuild (pyvista#4165)
Browse files Browse the repository at this point in the history
* no doc and no prebuild

* update docs

* Better description of preloading environment

* Fix build document warning

---------

Co-authored-by: Tetsuo Koyama <[email protected]>
  • Loading branch information
MatthewFlamm and tkoyama010 authored Mar 22, 2023
1 parent b9f4bbb commit 655bc0e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 28 deletions.
18 changes: 0 additions & 18 deletions .gitpod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,3 @@ tasks:
pip install --no-cache-dir pre-commit
pre-commit install --install-hooks
pip install -e .
make -C doc html
github:
prebuilds:
# enable for the default branch (defaults to true)
master: true
# enable for all branches in this repo (defaults to false)
branches: true
# enable for pull requests coming from this repo (defaults to true)
pullRequests: true
# enable for pull requests coming from forks (defaults to false)
pullRequestsFromForks: false
# add a check to pull requests (defaults to true)
addCheck: false
# add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
addComment: false
# add a "Review in Gitpod" button to the pull request's description (defaults to false)
addBadge: false
14 changes: 4 additions & 10 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -416,23 +416,17 @@ suites.
Using Gitpod Workspace
~~~~~~~~~~~~~~~~~~~~~~

A prebuilt gitpod workspace is available for a quick start development
A gitpod workspace is available for a quick start development
environment. To start a workspace from the main branch of pyvista, go
to `<https://gitpod.io/#https://github.com/pyvista/pyvista>`_. See
`Gitpod Getting Started
<https://www.gitpod.io/docs/getting-started>`_ for more details.

The workspace has vnc capability through the browser for
interactive plotting. The workspace also has prebuilt
interactive plotting. The workspace also has the ability to view the
documentation with a live-viewer. Hit the ``Go Live`` button
and browse to ``doc/_build/html``. The workspace is also prebuilt to
support pre-commit checks.

Workspaces started from the ``pyvista/pyvista`` repository will often
have prebuilt environments with dependencies installed. Workspaces
started from forks may not have prebuilt images and will start
building when starting a new workspace. It is safe to stop, for example
``Ctrl-C``, the documentation part of the build if unneeded.
and browse to ``doc/_build/html``. The workspace also preloads
pre-commit environments and installs requirements.

Unit Testing
~~~~~~~~~~~~
Expand Down

0 comments on commit 655bc0e

Please sign in to comment.