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

Add AST section to examples #545

Open
wants to merge 4 commits into
base: ppx-by-example
Choose a base branch
from

Conversation

pedrobslisboa
Copy link

@pedrobslisboa pedrobslisboa commented Dec 15, 2024

41 files where: 20 are pngs and 8 are old examples files deleted. So don't be scared

Captura de Tela 2024-12-15 às 19 11 58
Captura de Tela 2024-12-15 às 19 12 57

Description

This is the first part of adding the ppx-by-example to ppxlib
I will divide it into PR so we can review it better, focusing on the explanation and typos without having tons of files to review. It is really necessary that this section is easy to understand and is aligned with ppxlib.
@NathanReb Can you create a ppx-by-example base branch? So I can point this one to it, and after all merges (Other sections) on this branch, we move with the entire ppx-by-example branch to main?

AST

This PR adds the AST sections AST / Building ASTs / Destructing ASTs

How to test it (It's important to check it not only by code but also as styles)

  • At this branch run
     make doc
     open _build/default/_doc/_html/ppxlib/index.html
  • Access Examples
  • Access each section:
    • AST
    • Building an AST
    • Destructing an AST

Makefile Outdated
Copy link
Author

Choose a reason for hiding this comment

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

@NathanReb I've made some improvements on Makefile, can you check out if it makes sense?

The main feature is to add doc-dev, but I also added the help command

@pedrobslisboa
Copy link
Author

pedrobslisboa commented Dec 23, 2024

@patricoferris Tagging you for the review as you reacted to this PR

doc/dune Outdated
Comment on lines 10 to 12
(system "mkdir -p %{project_root}/_doc/_html/ppxlib/assets/images")
(system "cp -R ./images/ %{project_root}/_doc/_html/ppxlib/assets/images/"))))
Copy link
Author

Choose a reason for hiding this comment

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

Btw, I didn't know any other way to get assets on odoc. Do you guys happen to know?

@pedrobslisboa pedrobslisboa force-pushed the examples/ast branch 4 times, most recently from 7020fc9 to 7bf1887 Compare December 27, 2024 20:46
@NathanReb
Copy link
Collaborator

@pedrobslisboa just pushed a ppx-by-example branch, sorry for the delay!

@pedrobslisboa pedrobslisboa changed the base branch from main to ppx-by-example January 6, 2025 21:33
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.

2 participants