-
Notifications
You must be signed in to change notification settings - Fork 15
Adding Examples to the Helion Docs/site #330
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
base: main
Are you sure you want to change the base?
Conversation
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.
pre-commit run --all-files
or ./lint.sh
can help fix the lint errors.
For the tests you will need to run EXPECTTEST_ACCEPT=1 pytest test
to update expected results to include addeded docstrings.
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
examples/add |
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.
Should this be generated automatically too?
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.
Huh, hadnt considered that but it makes sense to do that. Will update that
docs/examples/add.rst
Outdated
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.
If these files are auto-generated, do we need to check them in? Perhaps they should go in gitignore?
@@ -0,0 +1,736 @@ | |||
Helion Puzzles |
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.
cc @drisspg
Co-authored-by: Jason Ansel <jansel@jansel.net>
Co-authored-by: Jason Ansel <jansel@jansel.net>
PR adds examples to the helion docs site:
Helion Puzzles is taken from a bento notebook created internally
The rest are examples taken from the .pys taken from examples/ folder.
Updates include:
Some mock ups below built locally