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.

Sign up for GitHub

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

Jump to bottom

docs: initialize documentation #129

Merged
merged 27 commits into from
Sep 9, 2024
Merged

docs: initialize documentation #129

merged 27 commits into from
Sep 9, 2024

Conversation

dtdang
Copy link
Contributor

@dtdang dtdang commented Aug 1, 2024 •
edited
Loading

What I did

Add docs to ape-vyper using docs-build repo to compile the sphinx documentation.

fixes: APE-53

How I did it

How to verify it

Checklist

  • Passes all linting checks (pre-commit and CI jobs)
  • New test cases have been added and are passing
  • Documentation has been updated
  • PR title follows Conventional Commit standard (will be automatically included in the changelog)

@dtdang dtdang requested a review from antazoey August 2, 2024 15:00
antazoey
antazoey previously approved these changes Aug 5, 2024
View reviewed changes
Copy link
Member

@antazoey antazoey left a comment

Choose a reason for hiding this comment

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

Not bad!
All the same feedback regarding easier usage via CLIs and custom GH-actions still apply, but I think it'll be easier to upgrade and iterate to that point.

We may want to do that next before upgrading all the plugins though, to save round-trips.

.github/workflows/docs.yml Outdated Show resolved Hide resolved
setup.py Outdated Show resolved Hide resolved
@antazoey antazoey changed the title feat: adding docs docs: initialize Documentation Sep 9, 2024
@antazoey antazoey changed the title docs: initialize Documentation docs: initialize documentation Sep 9, 2024
@antazoey
Copy link
Member

antazoey commented Sep 9, 2024

tests failing because of tests failing because of ApeWorX/ape#2270 but i can put a workaround in these tests for now

but i can put in a workaround for now

@antazoey antazoey merged commit c223e8c into ApeWorX:main Sep 9, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@antazoey antazoey antazoey approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dtdang @antazoey