Adds documentation + tutorials updated#87
Merged
dannielsantiago merged 36 commits intoPtyLab:mainfrom Apr 21, 2026
Merged
Conversation
…ta at package level
…; README updated
…mplementation with ipywidgets, defaults to normal visualization when head exists
Contributor
|
this PR is merged, the docs.yml CI file will deploy the webpage by creating a gh-pages branch. However, after this step, the admin must do the following steps: Settings > Pages > Deploy from a branch > under "branch", select gh-pages and from /root. This will deploy the documentation to ptylab.github.io/PtyLab.py/. @dboonz @roflmaostc could you please take care of this? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addressing #74 this PR adds documentation. Additionally the tutorials are now updated (fixed) and additional data download per notebook is streamlined. This is indeed not an exhaustive documentation, especially the details on API and specific examples for every method would make it complete, but this is already a pretty good start.
After this PR is merged, the
docs.ymlCI file will deploy the webpage by creating a gh-pages branch. However, after this step, the admin must do the following steps: Settings > Pages > Deploy from a branch > under "branch", select gh-pages and from /root.This will deploy the documentation to ptylab.github.io/PtyLab.py/.
@dboonz @roflmaostc could you please take care of this?
For local preview:
uv sync --extra docs, followed byuv run mkdocs serve