Skip to content

WIP - Mackenzie/edit documentation#71

Open
mackenziesnyder wants to merge 9 commits intokhanlab:integrate-condafrom
mackenziesnyder:mackenzie/edit-documentation
Open

WIP - Mackenzie/edit documentation#71
mackenziesnyder wants to merge 9 commits intokhanlab:integrate-condafrom
mackenziesnyder:mackenzie/edit-documentation

Conversation

@mackenziesnyder
Copy link

@mackenziesnyder mackenziesnyder commented Jun 2, 2025

Proposed changes

Describe the changes implemented in this pull request. If the changes fix a bug or resolves a feature request, be sure to link the issue. Please explain the issue and how the changes address the issue.

Types of changes

What types of changes does your code introduce? Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionalitiy)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [ x] Other (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you are unsure about any of the choices, don't hesitate to ask!

  • Changes have been tested to ensure that fix is effective or that a feature works.
  • Changes pass the unit tests
  • Code has been run through the poe quality task
  • [ x] I have included necessary documentation or comments (as necessary)
  • Any dependent changes have been merged and published

Notes

All PRs will undergo the unit testing before being reviewed. You may be requested to explain or make additional changes before the PR is accepted.

  • This pr is a documentation revamp to account for new changes with conda. It is currently missing the example section as we need to decide on test data to use and put that on dropbox or another platform users can access
  • it is modelled off of the autoafids readthedocs
  • for issue Update documentation to include the new conda instructions #70
  • still to do:
  • fix contributions page
  • test the singularity container and docker container with the readthedocs instructions

@Dhananjhay Dhananjhay changed the base branch from main to integrate-conda June 3, 2025 18:42
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.

1 participant