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

Reference test suite in installation documentation #8468

Merged
merged 4 commits into from
Oct 6, 2022
Merged

Reference test suite in installation documentation #8468

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fb91d15
Reference test suite in installation documentation
apmasell Sep 27, 2022
79c2b3a
Update and wrap line
apmasell Sep 30, 2022
5fb00df
Add reflink
apmasell Oct 4, 2022
6abd8f5
Merge remote-tracking branch 'origin/main' into issue8452
apmasell Oct 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/source/user/installing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,8 @@ Then you can build and install Numba from the top level of the source tree::

$ python setup.py install

If you wish to run the test suite, see the :doc:`developer documentation <../developer/contributing>`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please could this be line wrapped to 80 chars?

Also, if there's no anchor creating a link to the "how to run the test suite" part of the contributing docs, then perhaps it'd be a good idea to add one in there so there's a direct link that is available that can be easily shared (it also would mean this reference could jump straight to the relevant part of the docs).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure!

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks, I see in 79c2b3a there's no specific ref/link pair. An example of this for e.g. references and linking to the "continuous integration testing" section is:
anchor:

numba/docs/source/developer/contributing.rst

Line 325 in 061f21a

.. _continuous_integration_testing:

reference:

numba/docs/source/developer/contributing.rst

Line 75 in 061f21a

against the :ref:`continuous integration <continuous_integration_testing>`

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, didn't get pushed.

apmasell marked this conversation as resolved.
Show resolved Hide resolved

.. _numba-source-install-env_vars:

Build time environment variables and configuration of optional components
Expand Down