I’d like to register my package JackPolynomials (and others). I have a Github action for the documentation:
docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
with:
version: '1'
- run: |
julia --project=docs -e '
using Pkg
Pkg.develop(PackageSpec(path=pwd()))
Pkg.instantiate()'
- run: |
julia --project=docs -e '
using Documenter: doctest
using JackPolynomials
doctest(JackPolynomials)'
- run: julia --project=docs docs/make.jl
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
This generates the documentation at https://stla.github.io/JackPolynomials.jl/dev/. How to generate the documentation for a stable release? I took a look at the Github repo of some registered packages but I can’t figure out.
Your documenter.yml file is very different of mine. In particular it does not include the line julia --project=docs docs/make.jl, and this is the command which generates the doc. How does this work?
We both use the actions to checkout and setup Julia, but your manual steps are basically just the action GitHub - julia-actions/julia-docdeploy to which we pass the GitHub token and the documenter key (both used for deployment of the docs, but I am not 100% sure the documenter key is still needed).
Two other differences we have (but you can ignore):
The docs: job only runs on master, tags or PRs, but for PRs only those where a certain tag is present (this way we do not built docs on arbitrary PRs where we do not change the docs)
the note: job displays a note if the documentation is not run, to tell the first point to the user.
Good luck, I love this bot, since it really makes registration easy (and I hope your compat-section is complete), if there are mistakes (like compat entries missing) you will get feedback on that as well.
LinearAlgebra is a standard library and comes bundled with Julia. Setting a version restriction on this would not have any effect and should not be done.
