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

Document next steps for the user once they run the tool #205

Closed
paddyroddy opened this issue Oct 25, 2023 · 2 comments · Fixed by #418
Closed

Document next steps for the user once they run the tool #205

paddyroddy opened this issue Oct 25, 2023 · 2 comments · Fixed by #418
Labels
documentation Improvements or additions to documentation

Comments

@paddyroddy
Copy link
Member

@samcunliffe thought it would be good to say things like:

  • Create conda environment
  • Enter conda environment
  • pip install -e . package
  • Run pre-commit install
  • etc.
@paddyroddy paddyroddy added the documentation Improvements or additions to documentation label Oct 25, 2023
@paddyroddy paddyroddy mentioned this issue Jan 23, 2024
Closed
@paddyroddy
Copy link
Member Author

  • code of conduct
  • contributing guidelines
  • etc.

This was referenced Jan 23, 2024
Closed
Merged
@paddyroddy paddyroddy mentioned this issue Mar 22, 2024
Merged
@matt-graham
Copy link
Collaborator

Would also be worth mentioning steps for setting up deployment of documentation to GitHub Pages is user selected deploy_docs_to_github_pages option as discussed in #319.

@matt-graham matt-graham mentioned this issue Jun 5, 2024
Closed
@matt-graham matt-graham mentioned this issue Jun 13, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Adding tutorial on setting up package using template UCL-ARC/python-tooling
2 participants
@matt-graham @paddyroddy