Create initial documentation framework

.github/workflows/CI.yml

@@ -38,3 +38,39 @@ jobs:
  - uses: codecov/codecov-action@v4
  with:
  files: lcov.info
+
+ docs:
+ name: Documentation
+ runs-on: ubuntu-latest
+
+ # These permissions are needed to:
+ # - Checkout the repo
+ # - Delete old caches: https://github.com/julia-actions/cache#usage
+ # - Deploy the docs to the `gh-pages` branch: https://documenter.juliadocs.org/stable/man/hosting/#Permissions
+ permissions:
+ actions: write
+ contents: write
+ pull-requests: read
+ statuses: write
+ steps:
+ - uses: actions/checkout@v4
+ - uses: julia-actions/setup-julia@v2
+ with:
+ version: "1"
+ - uses: julia-actions/cache@v2
+ - name: Configure docs environment
+ shell: julia --project=docs --color=yes {0}
+ run: |
+ using Pkg
+ Pkg.develop(PackageSpec(path=pwd()))
+ Pkg.instantiate()
+ - uses: julia-actions/julia-docdeploy@v1
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ - name: Run doctests
+ shell: julia --project=docs --color=yes {0}
+ run: |
+ using Documenter: DocMeta, doctest
+ using Mocking: Mocking
+ DocMeta.setdocmeta!(Mocking, :DocTestSetup, :(using Mocking); recursive=true)
+ doctest(Mocking)

.gitignore

@@ -1,4 +1,6 @@
+/Manifest.toml
+/docs/Manifest.toml
+/docs/build
 *.jl.cov
 *.jl.*.cov
 *.jl.mem
-/Manifest.toml

docs/Project.toml

@@ -0,0 +1,3 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Mocking = "7ac61a21-9ca3-4383-ac4b-73a7de16e49a"

docs/make.jl

@@ -0,0 +1,23 @@
+using Documenter
+using Mocking: Mocking
+
+DocMeta.setdocmeta!(Mocking, :DocTestSetup, :(using Mocking); recursive=true)
+
+makedocs(;
+ modules=[Mocking],
+ authors="Curtis Vogt and contributors",
+ sitename="Mocking.jl",
+ format=Documenter.HTML(;
+ canonical="https://juliatesting.github.io/Mocking.jl",
+ edit_link="main",
+ assets=String[],
+ ),
+ pages=[
+ "Home" => "index.md",
+ ],
+)
+
+deploydocs(;
+ repo="github.com/JuliaTesting/Mocking.jl",
+ devbranch="main",
+)

docs/src/index.md

@@ -0,0 +1,14 @@
+```@meta
+CurrentModule = Mocking
+```
+
+# Mocking
+
+Documentation for [Mocking](https://github.com/JuliaTesting/Mocking.jl).
+
+```@index
+```
+
+```@autodocs
+Modules = [Mocking]
+```