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

Adding conda info for libraries, polishing #462

Closed
wants to merge 1 commit into from

Conversation

ajpowelsnl
Copy link
Contributor

This is a small PR to add info about using the Anaconda implementation of Python for Kokkos documentation work. It attempts to distinguish conda and pip resources, where necessary, and adds touches of polish here and there.

- furo
- myst-parser
- sphinx-copybutton
- m2r2
Copy link
Collaborator

Choose a reason for hiding this comment

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

i think all this above is superfluous, and we are just duplicating what is writte in the build_requirements.txt.

Copy link
Member

@dalg24 dalg24 Oct 19, 2023

Choose a reason for hiding this comment

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

Agreed, please refer to the requirement file and do not duplicate content. This would inevitably go out of date.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK. I'll. close this PR


Each of the above libraries can be installed using `conda` or `pip`.

These libraries are needed for local documentation rendering, a critical check *before* creating pull requests (PR), and updating existing PR.
Copy link
Collaborator

Choose a reason for hiding this comment

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

please remove this sentence, I don't think it adds much. We are already saying what the requirements are, the word says it all :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK

@ajpowelsnl
Copy link
Contributor Author

Consensus: does. not add substantively to the "getting started" process.

@ajpowelsnl ajpowelsnl closed this Oct 19, 2023
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

Successfully merging this pull request may close these issues.

3 participants