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

Move Developer Build documentation. #2993

Open
1uc opened this issue Jul 16, 2024 · 2 comments
Open

Move Developer Build documentation. #2993

1uc opened this issue Jul 16, 2024 · 2 comments

Comments

@1uc
Copy link
Collaborator

1uc commented Jul 16, 2024

I'd like to propose moving the developer build documentation from Building to the Developer Documentation. Mostly this is because the Developer Build (sensibly) contains Perf instructions. Finding the perf instruction would be easier if it where under developer documentation.

CC: @kbvw

@ramcdougal
Copy link
Member

Can you clarify the distinction between what you are considering developer build documentation from regular build? Is that things like the sanitizers?

@1uc
Copy link
Collaborator Author

1uc commented Jul 16, 2024

The distinction has already been made. We have an entire page dedicated to "developer build". Here:
https://nrn.readthedocs.io/en/latest/install/developer.html

I would move the whole thing to Developer Documentation, but if you feel it's where it needs to be that's fine too.

It seems to be roughly that things like building wheels, CI stuff like coverage, sanitizers, profilers, etc. are all topics for developers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants