Skip to content

Add docs page with Documenter #3

@ErikBuer

Description

@ErikBuer

First off, what a great package!

It is of great utility and I have already gotten good use of it!

All the examples are currently in the readme. It would be nice to get these in a Documenter page on github pages.

When you implement examples in Documenter, the examples will run each time the documentation is generated, ensuring that the examples are always working.

Running GLMakie on GitHub Actions can be a bit tricky. I have a working example that you can use as a starting point:
https://erikbuer.github.io/ArrayRadiation.jl/dev/Examples/element_radiation_pattern/

This GitHub CI YAML installs the necessary dependencies to run GLMakie on GitHub Actions.
https://github.com/ErikBuer/ArrayRadiation.jl/blob/main/.github/workflows/Documenter.yml

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions