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 tutorials #429

Merged
merged 3 commits into from
Jun 7, 2023
Merged

Docs add tutorials #429

merged 3 commits into from
Jun 7, 2023

Conversation

younesStrittmatter
Copy link
Collaborator

Description

add the tutorials after the introduction

Remarks (Optional)

This works, but since mkdocs doesn't seem to support having the same file (or import) at two different nav endpoints, a workaround is to import the falsification sampler twice

Copy link
Collaborator

@benwandrew benwandrew left a comment

Choose a reason for hiding this comment

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

also, all three new tutorials are not launching in Colab. it looks like a path issue somewhere, but i can't seem to resolve

Screen Shot 2023-06-03 at 14 00 18

mkdocs.yml Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
@younesStrittmatter
Copy link
Collaborator Author

I kind of think (and am reasonable confident) that the collab tutorials work as soon as the new documentation has been build. (The paths seems right to me, but they don't exist yet on gh-pages since the page have not yet been build)

Co-authored-by: benwandrew <benwallaceandrew@gmail.com>
@benwandrew
Copy link
Collaborator

I kind of think (and am reasonable confident) that the collab tutorials work as soon as the new documentation has been build. (The paths seems right to me, but they don't exist yet on gh-pages since the page have not yet been build)

ok, sounds good. i just saw that the colab urls for the working ones (eg Basic Usage for model disagreement sampler) matched the nav structure and naming exactly, whereas the url for the ‘Automated Theorist’ under ‘Tutorials’ just has the named bms-tutorial in it. anyway, my confusion, good to approve.

@benwandrew benwandrew self-requested a review June 3, 2023 18:50
Copy link
Member

@hollandjg hollandjg 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!

We might want to add a summary page for the tutorials, and possibly expand them later, so they aren't exactly the same as the originals.

We should also add the !pip install autora[with-the-right-options] to the original notebooks – that slipped through the net.

@younesStrittmatter younesStrittmatter added this pull request to the merge queue Jun 7, 2023
Merged via the queue into main with commit e8ca982 Jun 7, 2023
@younesStrittmatter younesStrittmatter deleted the docs-add-tutorials branch June 7, 2023 21:09
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