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

Create getting started notebook #776

Open
wants to merge 34 commits into
base: docs-v2
Choose a base branch
from
Open

Create getting started notebook #776

wants to merge 34 commits into from

Conversation

a-corni
Copy link
Collaborator

@a-corni a-corni commented Dec 9, 2024

A getting started notebook is created:

  • Only tackles AnalogDevice operations.
  • Introduces and redirects to the various components of the documentation.
  • Introduces the further notebooks.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@HGSilveri
Copy link
Collaborator

There seem to be some formatting issues, the ReviewNB rendering looked weird and the RTD build failed with some warnings

Copy link
Collaborator

@HGSilveri HGSilveri left a comment

Choose a reason for hiding this comment

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

A first review of the tutorial

tutorials/creating_sequences.ipynb Outdated Show resolved Hide resolved
tutorials/creating_sequences.ipynb Outdated Show resolved Hide resolved
tutorials/creating_sequences.ipynb Outdated Show resolved Hide resolved
tutorials/creating_sequences.ipynb Outdated Show resolved Hide resolved
tutorials/creating_sequences.ipynb Outdated Show resolved Hide resolved
@a-corni
Copy link
Collaborator Author

a-corni commented Jan 6, 2025

@ferulli1pasqal

tutorials/creating_sequences.ipynb Show resolved Hide resolved
tutorials/creating_sequences.ipynb Show resolved Hide resolved
tutorials/creating_sequences.ipynb Show resolved Hide resolved
tutorials/creating_sequences.ipynb Show resolved Hide resolved
tutorials/creating_sequences.ipynb Show resolved Hide resolved
tutorials/creating_sequences.ipynb Show resolved Hide resolved
Copy link
Collaborator

@HGSilveri HGSilveri left a comment

Choose a reason for hiding this comment

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

This is looking quite nice! Now it would be good to fix the RTD build so we can check what it will look like in the docs

docs/source/programming.md Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
@HGSilveri HGSilveri changed the base branch from develop to docs-v2 January 8, 2025 15:52
docs/source/programming.md Outdated Show resolved Hide resolved
docs/source/programming.md Outdated Show resolved Hide resolved
docs/source/programming.md Show resolved Hide resolved
docs/source/programming.md Outdated Show resolved Hide resolved
docs/source/programming.md Outdated Show resolved Hide resolved
tutorials/creating_sequences.ipynb Outdated Show resolved Hide resolved
tutorials/creating_sequences.ipynb Outdated Show resolved Hide resolved
tutorials/creating_sequences.ipynb Outdated Show resolved Hide resolved
tutorials/creating_sequences.ipynb Outdated Show resolved Hide resolved
tutorials/creating_sequences.ipynb Outdated Show resolved Hide resolved
tutorials/creating_sequences.ipynb Outdated Show resolved Hide resolved
tutorials/creating_sequences.ipynb Outdated Show resolved Hide resolved
Copy link
Collaborator

@HGSilveri HGSilveri left a comment

Choose a reason for hiding this comment

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

LGTM, let's go 🚀

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