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

docs: add installation page to main documentation #505

Merged
merged 10 commits into from
Jul 3, 2023

Conversation

benwandrew
Copy link
Collaborator

@benwandrew benwandrew commented Jun 30, 2023

Description

resolves #464

Type of change

  • docs: Documentation only changes

Questions (Optional)

  • not sure where to put this... first page under "User Guide"?
  • also not sure what @musslick mean't by the last task -- "We should also consider adding the name of the autora pip/conda package for each tool in the main doc file (index.md) of the respectvie package."

Remarks (Optional)

  • to me, listing all the optional dependencies seems overkill and likely to get lost in the process of adding new ones going forward. as such, i opted to refer people to the 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...

@benwandrew benwandrew linked an issue Jun 30, 2023 that may be closed by this pull request
6 tasks
docs/installation.md Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
benwandrew and others added 3 commits June 30, 2023 16:05
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>
@benwandrew benwandrew marked this pull request as ready for review June 30, 2023 20:26
@musslick
Copy link
Collaborator

musslick commented Jul 2, 2023

Hey @benwandrew , regarding the last task:
We should list the name of each optional dependency that can be installed with autora. Ideally in a table, e.g.,

| type | package name | description |  depenency |
-------------------------------------------------
| experimentalist | experimentalist-falsification | samples experimental conditions that are predicted to invalidate a model | optional |

@musslick
Copy link
Collaborator

musslick commented Jul 2, 2023

@benwandrew
Regarding the remark: I think we should still list all packages in the doc. Better an old list than no list at all. Pointing the user to the pytoml is cumbersome for them and will scare off unexperienced users.

Copy link
Collaborator

@musslick musslick left a 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)

docs/installation.md Outdated Show resolved Hide resolved
@musslick
Copy link
Collaborator

musslick commented Jul 3, 2023

Now resolved!

Copy link
Collaborator

@musslick musslick left a 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!

@benwandrew
Copy link
Collaborator Author

ok, all sounds good. and thanks for handling the list!

assume we're happy with placement as first page under User Guide?

@musslick
Copy link
Collaborator

musslick commented Jul 3, 2023

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"

@benwandrew
Copy link
Collaborator Author

@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?

Copy link
Collaborator

@younesStrittmatter younesStrittmatter left a 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

@benwandrew benwandrew added this pull request to the merge queue Jul 3, 2023
Merged via the queue into main with commit 6fecbe2 Jul 3, 2023
@benwandrew benwandrew deleted the docs/add-installation-page-to-main-documentation branch July 3, 2023 18:55
@benwandrew benwandrew restored the docs/add-installation-page-to-main-documentation branch July 3, 2023 19:07
@benwandrew
Copy link
Collaborator Author

upon another quick read, wondering why certain samplers are listed as required dependencies? if this needs changing, i might also grab a couple typos in another PR...

Screen Shot 2023-07-03 at 15 08 55

@benwandrew benwandrew deleted the docs/add-installation-page-to-main-documentation branch July 3, 2023 21:23
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.

Add "Installation" page to main documentation
3 participants