-
Notifications
You must be signed in to change notification settings - Fork 5
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
docs: add installation page to main documentation #505
docs: add installation page to main documentation #505
Conversation
Co-authored-by: Younes Strittmatter <younes_strittmatter@brown.edu>
Co-authored-by: Younes Strittmatter <younes_strittmatter@brown.edu>
Co-authored-by: Younes Strittmatter <younes_strittmatter@brown.edu>
Hey @benwandrew , regarding the last task:
|
@benwandrew |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks all great, except we should still add a complete list of dependencies in a table (e.g., type, package name, description; see the example in the comment)
Now resolved! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added the list of dependencies and restructured a bit. Now looks good on my end!
ok, all sounds good. and thanks for handling the list! assume we're happy with placement as first page under User Guide? |
Actually, might be better right below "Introduction" and above "Tutorials" |
@younesStrittmatter can you approve this when you get a chance? because you requested changes, it is not letting me merge until you approve. or perhaps i'm missing another outstanding requested change? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good to me
Description
resolves #464
Type of change
Questions (Optional)
Remarks (Optional)
pyproject.toml
file for a complete list of options. this is comprehensive, and will necessarily be updated as optional dependencies are added. happy to change and create some sort of table, but aiming for effective viable solution that doesn't add documentation liability in the future...