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

Add pyk documentation generation script #4420

Merged
merged 8 commits into from
Jun 6, 2024
Merged

Add pyk documentation generation script #4420

merged 8 commits into from
Jun 6, 2024

Conversation

tothtamas28
Copy link
Contributor

@tothtamas28 tothtamas28 commented Jun 5, 2024 •
edited
Loading

Fixes #4413

  • Adds a script pyk/docs/generate.sh that sets up a virtual environment in which the Sphinx docs can be built without error. In particular, the runtime bindings package needs to be available.
  • Changes the test and release workflows to run this script in a K Docker container.

@tothtamas28 tothtamas28 added the pyk label Jun 5, 2024
@tothtamas28 tothtamas28 self-assigned this Jun 5, 2024
@tothtamas28 tothtamas28 linked an issue Jun 5, 2024 that may be closed by this pull request
[PyK Docs] Some pages on PyK documentation don't have the expected content of modules/functions #4413
Closed
@tothtamas28 tothtamas28 force-pushed the fix-pyk-docs branch 11 times, most recently from d3dc283 to 18a939d Compare June 6, 2024 13:07
@tothtamas28
Make pytest a runtime dependency
4c6bbcf 
This is required by the `pyk.testing` package.
@tothtamas28
Add documentation generation script
511ce3a 
Sets up a virtual environment, then runs Sphinx commands from it.
@tothtamas28 tothtamas28 force-pushed the fix-pyk-docs branch 3 times, most recently from eed4890 to aa2b300 Compare June 6, 2024 15:39
@tothtamas28 tothtamas28 marked this pull request as ready for review June 6, 2024 17:12
@tothtamas28 tothtamas28 requested a review from a team as a code owner June 6, 2024 17:12
@tothtamas28
Copy link
Contributor Author

Release workflows sliced for test purposes: 6fdc5e1
Test run: https://github.com/runtimeverification/k/actions/runs/9404319093

Robertorosmaninho
Robertorosmaninho approved these changes Jun 6, 2024
View reviewed changes
Copy link
Collaborator

@Robertorosmaninho Robertorosmaninho left a comment

Choose a reason for hiding this comment

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

LGTM

@tothtamas28 tothtamas28 merged commit 0db5358 into develop Jun 6, 2024
17 checks passed
@tothtamas28 tothtamas28 deleted the fix-pyk-docs branch June 6, 2024 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Robertorosmaninho Robertorosmaninho Robertorosmaninho approved these changes

@Baltoli Baltoli Awaiting requested review from Baltoli

Assignees

@tothtamas28 tothtamas28

Labels
pyk
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[PyK Docs] Some pages on PyK documentation don't have the expected content of modules/functions
2 participants
@tothtamas28 @Robertorosmaninho