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

Building document for a tag on Github #1729

Closed
ericqu opened this issue Nov 12, 2021 · 2 comments
Closed

Building document for a tag on Github #1729

ericqu opened this issue Nov 12, 2021 · 2 comments

Comments

@ericqu
Copy link

ericqu commented Nov 12, 2021

My documentation works fine when I run it on the "dev".
However, I now would like to add documentation for each future new tagged version.
My package is not registered, as I don't think there is yet enough interest.

The documentation indicates how to work with "Tagbot"; however, I suppose this won't be relevant since the package is not registered.

Is there a way to generate the documentation using only the tags from Github?

for reference, here is the setup for Documenter

name: Documentation

on:
  push:
    branches:
      - main
    tags: '*'
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: julia-actions/setup-julia@latest
        with:
          version: '1.6'
      - name: Install dependencies
        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
      - name: Build and deploy
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
        run: julia --project=docs/ docs/make.jl

and the make.jl

push!(LOAD_PATH,"../src/")
using Documenter
using StatsModels, DataFrames, VegaLite
using LinearRegression

makedocs(sitename="LinearRegression.jl", modules = [LinearRegression] ,
    pages = Any[
        "Home" => "index.md",
        "Tutorials" => Any[
            "Basic" => "basic_tutorial.md",
            "Multiple regression" => "multi_tutorial.md" ]
    ])

deploydocs(
    repo = "github.com/ericqu/LinearRegression.jl.git",
    push_preview = false,
    devbranch = "main",
    devurl = "dev",
)
@fredrikekre
Copy link
Member

Documenter doesn't care who makes the tag so it should just work. What is the error? Is it public so you can link some logs?

@ericqu
Copy link
Author

ericqu commented Nov 12, 2021

@fredrikekre Thank you for looking into this.
You're right, I probably should have tried first, it worked as advertised, no problem to report.

@ericqu ericqu closed this as completed Nov 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants