Skip to content

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

sekyondaMeta
Copy link

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:

  • Update to makefile to generate the .rst examples from the .py
  • Docstrings added to the .py examples to add some clarification
  • Minor adjustments to index.md and installation .md for organization

Some mock ups below built locally

Screenshot 2025-07-17 at 11 11 12 Screenshot 2025-07-17 at 11 10 39 Screenshot 2025-07-17 at 11 09 27

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Jul 17, 2025
Copy link
Contributor

@jansel jansel left a 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
Copy link
Contributor

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?

Copy link
Author

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

Copy link
Contributor

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
Copy link
Contributor

Choose a reason for hiding this comment

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

sekyondaMeta and others added 4 commits July 21, 2025 13:34
Co-authored-by: Jason Ansel <jansel@jansel.net>
Co-authored-by: Jason Ansel <jansel@jansel.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Meta Open Source bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants