[BUG]: In the "First Steps", "Compiling the test cases" section of the documentation, there is no context as to where to run cmake.

[uneasyalliance]

Required prerequisites

• Make sure you've read the documentation. Your issue may be addressed there.
• Search the issue tracker and Discussions to verify that this hasn't already been reported. +1 or comment there if it has.
• Consider asking first in the Gitter chat room or in a Discussion.

Problem description

In the "First Steps", "Compiling the test cases" section of the documentation, there is no context as to where to run cmake. There is no context as to where the test cases are located. I installed via pip on macos.

Reproducible example code

location of pybind11:

python3 -m pip install pybind11
Requirement already satisfied: pybind11 in /Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages (2.9.2)

[uneasyalliance]

After looking at this a little more, and guessing that this documentation applies specifically to a SOURCE download (rather than a pip install as I initially did), I cloned the repo and was able to build and run the tests.

Maybe the source install is implied by "Before getting started, make sure that development environment is set up to compile the included set of test cases.", but I think this could be made clearer.

[henryiii]

Wheels don't include the tests, yes. Do you see something you could improve, like "starting with a git checkout" or something like that?

[uneasyalliance]

Thanks for replying. That's exactly what I was getting at. I suppose the most general way to say it would be simply "install a source distribution" and point to the github page which gives a few download options. But too much installation instruction on the "first steps" page would be redundant to the "installing the library" page, I think. That page is not clear as to what's a full source install, however. I installed with pip after reading "You can download the sources and CMake files as a Python package from PyPI using Pip. Just use: pip install pybind11".

[jenhaoyang]

I also encounter to this situation. Maybe just move the Compiling the test cases part to the Include as a submodule section.