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.

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

skip or avoid creating files in doc build #2748

Merged
merged 2 commits into from
Jun 12, 2022
Merged

Conversation

akaszynski
Copy link
Member

The following files are created on a fresh build of the documentation:

  • doc/my_theme.json
  • doc/sample
  • my_theme.json
  • sample
  • single_sphere_pvd.gif
  • sphere_pvd.gif

This cleans up our documentation build by avoiding generating these files by either skipping tests or being smart about how we generate example image files.

@github-actions github-actions bot added the documentation Anything related to the documentation/website label Jun 6, 2022
@codecov
Copy link

codecov bot commented Jun 6, 2022

Codecov Report

Merging #2748 (d02372d) into main (904b986) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2748   +/-   ##
=======================================
  Coverage   93.83%   93.83%           
=======================================
  Files          76       76           
  Lines       16232    16232           
=======================================
  Hits        15231    15231           
  Misses       1001     1001           

@akaszynski
Copy link
Member Author

Calling this sufficiently reviewed and merging by Monday.

Copy link
Member

@adeak adeak left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@akaszynski akaszynski merged commit 19b4b67 into main Jun 12, 2022
@akaszynski akaszynski deleted the docs/rm_build_files branch June 12, 2022 18:32
akaszynski added a commit that referenced this pull request Jun 14, 2022
* skip or avoid creating files in doc build

* remove mention of _get_default_tempdir
akaszynski added a commit that referenced this pull request Jun 18, 2022
* do not deep copy on assigning scalars

* fix garbage collection

* clean up collection test

* add types

* fix docstring

* fix docstring

* fix type

* Rename shallow copy, fix some typos

* Apply suggestions from code review

Co-authored-by: Andras Deak <adeak@users.noreply.github.com>

* cleanup based on suggestions

* always return pyvista_ndarray

* Update tests/test_utilities.py

Co-authored-by: Andras Deak <adeak@users.noreply.github.com>

* return only pyvista_ndarray

* fix test

* add missing image cache png (#2765)

* Update information on the translation project (#2743)

* Update information of translation project

* Apply suggestions from code review

* Apply suggestions from code review

* Apply suggestions from code review

* Update doc/index.rst

Co-authored-by: Alex Kaszynski <akascap@gmail.com>
Co-authored-by: Andras Deak <adeak@users.noreply.github.com>

* Update hypothesis requirement from <6.47.1 to <6.47.2 (#2771)

Updates the requirements on [hypothesis](https://github.com/HypothesisWorks/hypothesis) to permit the latest version.
- [Release notes](https://github.com/HypothesisWorks/hypothesis/releases)
- [Commits](HypothesisWorks/hypothesis@hypothesis-ruby-0.0.1...hypothesis-python-6.47.1)

---
updated-dependencies:
- dependency-name: hypothesis
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* update pre-commit hooks (#2776)

Co-authored-by: akaszynski <akaszynski@users.noreply.github.com>

* Add fill arg to Polygon (#2767)

* Add generate_polygon arg to Polygon

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Andras Deak <adeak@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Andras Deak <adeak@users.noreply.github.com>

* skip or avoid creating files in doc build (#2748)

* skip or avoid creating files in doc build

* remove mention of _get_default_tempdir

* Fix the error running by CodeQL. (#2772)

* Create codeql-analysis.yml

* Update README.rst

* Update app.py

* Fix by isort

* Delete codeql-analysis.yml

* Apply suggestions from code review

* Add extrude_trim filter (#2600)

* Add extrude-trim.py

* Add example comment

* Add test

* Add an inplace test

* Add extrude_trim filter

* Apply suggestions from code review

* Apply suggestions from code review

* Apply suggestions from code review

* Update pyvista/core/filters/poly_data.py

Co-authored-by: Phil Chiu <whophil@users.noreply.github.com>

* Apply suggestions from code review

* Fix by black

* Fix by isort

* Apply suggestions from code review

* Apply suggestions from code review

* Apply suggestions from code review

* Apply suggestions from code review

* Apply suggestions from code review

* Apply suggestions from code review

* Apply suggestions from code review

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: MatthewFlamm <39341281+MatthewFlamm@users.noreply.github.com>

* improve example

Co-authored-by: Phil Chiu <whophil@users.noreply.github.com>
Co-authored-by: MatthewFlamm <39341281+MatthewFlamm@users.noreply.github.com>
Co-authored-by: Alex Kaszynski <akascap@gmail.com>

* Update hypothesis requirement from <6.47.2 to <6.47.3 (#2780)

Updates the requirements on [hypothesis](https://github.com/HypothesisWorks/hypothesis) to permit the latest version.
- [Release notes](https://github.com/HypothesisWorks/hypothesis/releases)
- [Commits](HypothesisWorks/hypothesis@hypothesis-ruby-0.0.1...hypothesis-python-6.47.2)

---
updated-dependencies:
- dependency-name: hypothesis
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Fail when regression image is missing on CI (#2778)

* optionally fail when image is missing

* use in linux tests instead of windows

* remove failing test

* Return correct scalar type for pyvista_ndarray (#2770)

* fix return types

* override __array_wrap__

* Apply suggestions from code review

* Update pyvista/core/pyvista_ndarray.py

Co-authored-by: Andras Deak <adeak@users.noreply.github.com>

Co-authored-by: Andras Deak <adeak@users.noreply.github.com>

* fix docstring return types

* cleanup docs

* remove code duplication

* Minor improvements from code review

* move complex collection test to test_collection

* Apply suggestions from code review

Co-authored-by: Andras Deak <adeak@users.noreply.github.com>

* Fix array retrieval for VTK objects, add tests for coverage

Co-authored-by: Andras Deak <adeak@users.noreply.github.com>
Co-authored-by: Tetsuo Koyama <tkoyama010@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: akaszynski <akaszynski@users.noreply.github.com>
Co-authored-by: Phil Chiu <whophil@users.noreply.github.com>
Co-authored-by: MatthewFlamm <39341281+MatthewFlamm@users.noreply.github.com>
Co-authored-by: Andras Deak <deak.andris@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to the documentation/website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants