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

merged 4 commits into from Oct 6, 2022

Conversation

apmasell
Copy link
Contributor

As titled. Closes #8452.

stuartarchibald
stuartarchibald reviewed Sep 30, 2022
View reviewed changes
Copy link
Contributor

@stuartarchibald stuartarchibald left a comment

Choose a reason for hiding this comment

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

Thanks for the patch, couple of minor things to resolve else looks good.

docs/source/user/installing.rst Outdated
@@ -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.

docs/source/user/installing.rst Outdated Show resolved Hide resolved
@stuartarchibald stuartarchibald added 4 - Waiting on author Waiting for author to respond to review and removed 3 - Ready for Review labels Sep 30, 2022
@stuartarchibald stuartarchibald added this to the Numba 0.57 RC milestone Sep 30, 2022
@stuartarchibald stuartarchibald added the Effort - short Short size effort needed label Sep 30, 2022
@stuartarchibald stuartarchibald self-assigned this Sep 30, 2022
@apmasell apmasell added 3 - Ready for Review and removed 4 - Waiting on author Waiting for author to respond to review labels Sep 30, 2022
@stuartarchibald stuartarchibald added the 4 - Waiting on author Waiting for author to respond to review label Oct 4, 2022
@apmasell apmasell removed the 4 - Waiting on author Waiting for author to respond to review label Oct 4, 2022
stuartarchibald
stuartarchibald reviewed Oct 4, 2022
View reviewed changes
docs/source/user/installing.rst Outdated
@@ -152,6 +152,9 @@ 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 instructions in
:doc:`developer documentation <running-tests>`.
Copy link
Contributor

Choose a reason for hiding this comment

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

This doesn't seem to render correctly in the RTD build, might need to be a :ref: ?

@stuartarchibald
Copy link
Contributor

NOTE: build failures are not related to this PR. #8486 is an attempt to fix.

stuartarchibald
stuartarchibald reviewed Oct 4, 2022
View reviewed changes
docs/source/user/installing.rst Outdated
Comment on lines 155 to 156
If you wish to run the test suite, see the instructions in
:ref:`developer documentation <running-tests>`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you wish to run the test suite, see the instructions in
:ref:`developer documentation <running-tests>`.
If you wish to run the test suite, see the instructions in the
:ref:`developer documentation <running-tests>`.

@apmasell
Add reflink
5fb00df 
As titled.
@stuartarchibald
Copy link
Contributor

@apmasell I think mainline needs merging in to pick up the changes to the Azure CI job config for the windows build from #8486 else this PR will continue using the job config that is "broken". Once that's done builds should pass.

stuartarchibald
stuartarchibald approved these changes Oct 5, 2022
View reviewed changes
Copy link
Contributor

@stuartarchibald stuartarchibald left a comment

Choose a reason for hiding this comment

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

Thanks for the patch, the docs appear to be rendering correctly on inspection!

@stuartarchibald stuartarchibald added 5 - Ready to merge Review and testing done, is ready to merge and removed 3 - Ready for Review labels Oct 5, 2022
@sklam sklam merged commit dbce821 into numba:main Oct 6, 2022
@apmasell apmasell deleted the issue8452 branch November 18, 2022 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stuartarchibald stuartarchibald stuartarchibald approved these changes

@sklam sklam Awaiting requested review from sklam

Assignees

@stuartarchibald stuartarchibald

Labels
5 - Ready to merge Review and testing done, is ready to merge Effort - short Short size effort needed
Projects
None yet
Milestone
Numba 0.57 RC
Development

Successfully merging this pull request may close these issues.

Documentation doesn't explain how to run tests
3 participants
@apmasell @stuartarchibald @sklam