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 documentation with Documenter #46

Merged
merged 5 commits into from
Jun 28, 2024
Merged

Add documentation with Documenter #46

merged 5 commits into from
Jun 28, 2024

Conversation

hellemo
Copy link
Member

@hellemo hellemo commented Jun 28, 2024

Add documentation generated with Documenter to generate docs that may be referred to from other packages' documentation. This is mainly based on information currently in README, which perhaps could then be simplified to make sure examples remain working with doctests.

TO DO:

  • setup build at github
  • update README with links to documentation

@hellemo hellemo requested a review from trulsf June 28, 2024 12:12
@hellemo hellemo merged commit ebed73b into main Jun 28, 2024
6 checks passed
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