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 API docs #11

Open
jgaskins opened this issue Jul 31, 2022 · 0 comments
Open

Add API docs #11

jgaskins opened this issue Jul 31, 2022 · 0 comments

Comments

@jgaskins
Copy link
Owner

jgaskins commented Jul 31, 2022

Use GitHub pages for this and generate the docs with this command:

crystal docs --project-version=$VERSION --source-refname=v$VERSION

A script should probably be written to run that that, which would require a version to be supplied. Ideally, it would work the way the Crystal folks support multiple versions in their API docs with a dropdown (see image below), but I don't know how they do that. The retroactive documentation can be added later, though.

Screenshot of the dropdown from the Crystal language API docs, showing the nightly build on top followed by every released version back to 1.3.0, with more continuing below the bottom edge of the screenshot

I'll have to enable GHP on this repo, as well, which will host it at https://jgaskins.dev/neo4j.cr

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

No branches or pull requests

1 participant