Detect conda environments more reliably

[joaander]

Description

Detect if linking to tbb in a conda environment by checking for the conda-meta directory relative to the found TBB library.

Motivation and Context

Fix readthedocs builds. Also support conda environments installed via other means (i.e. conda create --prefix).

Resolves: #735

How Has This Been Tested?

Will check the RTD PR build and validate that the docs build.

Screenshots

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds or improves functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation improvement (updates to user guides, docstrings, or developer docs)

Checklist:

• I have read the CONTRIBUTING document.
• My code follows the code style of this project.
• I have updated the documentation (if relevant).
• I have added tests that cover my changes (if relevant).
• All new and existing tests passed.
• I have updated the credits.
• I have updated the Changelog.

[codecov]

Codecov Report

Merging #736 (860fde7) into master (8151715) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #736   +/-   ##
=======================================
  Coverage   55.32%   55.32%           
=======================================
  Files          16       16           
  Lines        2404     2404           
  Branches       35       35           
=======================================
  Hits         1330     1330           
  Misses       1061     1061           
  Partials       13       13           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8151715...860fde7. Read the comment docs.

[tommy-waltmann]

How do we check that this won't break like the previous docs did?

[bdice]

How do we check that this won't break like the previous docs did?

I don’t know of a way to make ReadTheDocs fail when the docs can’t be rendered in this way.

The release process I follow has a manual step for ensuring that ReadTheDocs is rendering, and I forgot / skipped that step.

[tommy-waltmann]

Ok, if we follow that step this time, then we should be fine. I just wanted to make sure that whatever slipped under our nose last time wasn't going to happen again.

[bdice]

Ok, if we follow that step this time, then we should be fine. I just wanted to make sure that whatever slipped under our nose last time wasn't going to happen again.

The best thing to do would be to create a pull request template for releases that includes all this information as a checklist. I’ll create an issue for that. (Edit: #737)

[joaander]

There is a fail_on_warning setting: https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx . I think if that were enabled, the rtd pull request task would have failed.