Repository navigation
Documentation site and release 0.2.0 - #4
Merged
Merged
Conversation
- MkDocs Material site: landing page, example datasets (story cards), methodology with rendered math, design choices, validation, Neo4j guide, API reference generated from docstrings, changelog - Docs workflow deploys to GitHub Pages from main; CI builds the docs strictly on every push and pull request - selftest docstring in numpy format; results page link fixed for the site - Version 0.2.0 (pyproject, package, CITATION.cff); changelog dated - README and package metadata link to the documentation site
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a documentation site (deployed to GitHub Pages from main), a strict docs build in CI, and prepares release 0.2.0: version bump, dated changelog, links to the docs site.