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 docs #2

Merged
merged 9 commits into from
Nov 5, 2023
Merged

Add docs #2

merged 9 commits into from
Nov 5, 2023

Conversation

king-p3nguin
Copy link
Contributor

Before submitting, please check the following:

  • Make sure you have tests for the new code and that test passes (run tox)
  • format added code by black -l 120 <filename>
  • If applicable, add a line to the [unreleased] part of CHANGELOG.md, following keep-a-changelog.

Then, please fill in below:

Context (if applicable):

Description of the change:

  • Add docs
  • Run CI on schedule

Related issue:

also see that checks (github actions) pass.
If lint check keeps failing, try installing black==22.8.0 as behavior seems to vary across versions.

@king-p3nguin
Copy link
Contributor Author

king-p3nguin commented Nov 4, 2023

@shinich1 I added a tutorial and module references in the document. Since the tutorial covers most of the functionality of graphix-perceval currently implemented, I left the example section blank.

@shinich1 shinich1 merged commit 5cb767b into master Nov 5, 2023
9 checks passed
@king-p3nguin king-p3nguin deleted the add-docs branch November 5, 2023 09:28
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