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

Update dev docs after setuptools update #37976

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

thomashampson
Copy link
Contributor

Description of work

Update dev docs after the setuptools deprecation warnings were fixed here.

Fixes #37934

To test:

  • Make sure the new instructions work on all OS.
  • Make sure the docs are correctly formatted.

This does not require release notes because it's a dev-docs update


Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.


.. hlist::
:columns: 1

- On Linux: ``workbench --single-process``
- On Linux & macOS: ``workbench --single-process``
- On Windows: ``workbench-script.pyw --single-process``
Copy link
Contributor Author

@thomashampson thomashampson Sep 25, 2024

Choose a reason for hiding this comment

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

I think this (the Windows line) will have to change because the .pyw file will no longer be there.

cailafinn and others added 2 commits October 17, 2024 16:59
Provide steps to configure CLion without needing to activate the conda environment from the terminal. This helps when working on Mantid and other projects simultaneously in CLion.

Signed-off-by: Jose Borreguero <borreguero@gmail.com>
@jmborr
Copy link
Member

jmborr commented Oct 21, 2024

@thomashampson I included some additional documentation on building with CLion for the optional scenario of starting CLion from a terminal without having to first activate the mantid-developer conda environment

@thomashampson thomashampson marked this pull request as ready for review October 28, 2024 14:23
@sf1919 sf1919 added this to the Release 6.12 milestone Nov 22, 2024
@sf1919 sf1919 added the Documentation Issues and pull requests related to documentation label Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues and pull requests related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update dev debugging docs
4 participants