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

Simplified CI for tutorials + Tutorial Docs #1686

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

Conversation

abejgonzalez
Copy link
Contributor

@abejgonzalez abejgonzalez commented Dec 7, 2023

  • Adds a new tutorial section to the docs for people to add to.
    • If written with code-blocks and only:: directives you can auto-generate a tutorial script that could be added to CI. A script is built by adding all code-blocks and only:: blocks into a script. The only:: blocks delete prior code-blocks and are not printed out in the RST.
  • Simplifies CI for the tutorials (makes it easier for people to add tutorial without understanding CI bloat).

Related PRs / Issues:

Type of change:

  • Bug fix
  • New feature
  • Other enhancement

Impact:

  • RTL change
  • Software change (RISC-V software)
  • Build system change
  • Other

Contributor Checklist:

  • Did you set main as the base branch?
  • Is this PR's title suitable for inclusion in the changelog and have you added a changelog:<topic> label?
  • Did you state the type-of-change/impact?
  • Did you delete any extraneous prints/debugging code?
  • Did you mark the PR with a changelog: label?
  • (If applicable) Did you update the conda .conda-lock.yml file if you updated the conda requirements file?
  • (If applicable) Did you add documentation for the feature?
  • (If applicable) Did you add a test demonstrating the PR?
  • (If applicable) Did you mark the PR as Please Backport?

@abejgonzalez abejgonzalez self-assigned this Dec 7, 2023
@abejgonzalez abejgonzalez changed the title Add initial CI tutorial area Simplified CI for tutorials + Tutorial Docs Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant