Improve CI

.github/workflows/DocPreviewCleanup.yml

@@ -0,0 +1,28 @@
+name: Doc Preview Cleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v3
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+            if [ -d "previews/PR$PRNUM" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "documenter@juliadocs.github.io"
+              git rm -rf "previews/PR$PRNUM"
+              git commit -m "delete preview"
+              git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+              git push --force origin gh-pages-new:gh-pages
+            fi
+        env:
+            PRNUM: ${{ github.event.number }}

README.md

@@ -1,13 +1,10 @@
 # GraphsBase
 
-<!-- [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaGraphs.github.io/GraphsBase.jl/stable/) -->
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaGraphs.github.io/GraphsBase.jl/dev/)
 [![Build Status](https://github.com/JuliaGraphs/GraphsBase.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaGraphs/GraphsBase.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/JuliaGraphs/GraphsBase.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaGraphs/GraphsBase.jl)
 [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
 [![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
-<!-- [![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
-[![PkgEval](https://JuliaCI.github.io/NanosoldierReports/pkgeval_badges/G/GraphsBase.svg)](https://JuliaCI.github.io/NanosoldierReports/pkgeval_badges/report.html) -->
 
 Basic interface and structures for the JuliaGraphs ecosystem
 

docs/Project.toml

@@ -1,3 +1,6 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 GraphsBase = "ad2ac648-372e-45be-9d57-a550431b71c3"
+
+[compat]
+Documenter = "1"

docs/make.jl

@@ -6,15 +6,15 @@ DocMeta.setdocmeta!(GraphsBase, :DocTestSetup, :(using GraphsBase); recursive=tr
 makedocs(;
     modules=[GraphsBase],
     authors="JuliaGraphs contributors",
-    repo="https://github.com/JuliaGraphs/GraphsBase.jl/blob/{commit}{path}#{line}",
     sitename="GraphsBase.jl",
     format=Documenter.HTML(;
         prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://JuliaGraphs.github.io/GraphsBase.jl",
-        edit_link="main",
+        canonical="https://juliagraphs.org/GraphsBase.jl",
         assets=String[],
     ),
     pages=["Home" => "index.md"],
 )
 
-deploydocs(; repo="github.com/JuliaGraphs/GraphsBase.jl", devbranch="main")
+deploydocs(;
+    repo="github.com/JuliaGraphs/GraphsBase.jl", devbranch="main", push_preview=true
+)

docs/src/index.md

@@ -6,9 +6,13 @@ CurrentModule = GraphsBase
 
 Documentation for [GraphsBase](https://github.com/JuliaGraphs/GraphsBase.jl).
 
-```@index
-```
+## API reference
 
 ```@autodocs
 Modules = [GraphsBase]
 ```
+
+## Index
+
+```@index
+```

src/GraphsBase.jl

@@ -1,5 +1,8 @@
-module GraphsBase
+"""
+    GraphsBase
 
-# Write your package code here.
+The basic interface and graph types for the JuliaGraphs ecosystem.
+"""
+module GraphsBase
 
 end