Merge #99 from branch docs-env

Author: goerz

.github/workflows/ci.yml

@@ -111,10 +111,12 @@ jobs:
       - uses: julia-actions/setup-julia@v2
         with:
           version: '1'
-      - name: "Instantiate test environment"
-        run: julia --project=test devrepl.jl
-      - name: "Build documentation"
-        run: julia --project=test docs/make.jl
+      - name: Configure doc environment
+        shell: julia --project=docs --color=yes {0}
+        run: |
+          using Pkg
+          Pkg.instantiate()
+      - uses: julia-actions/julia-docdeploy@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

Makefile

@@ -32,8 +32,11 @@ devrepl:  ## Start an interactive REPL for testing and building documentation
 test/Manifest.toml:
 	$(JULIA) --project=test --banner=no --startup-file=yes -e 'include("devrepl.jl")'
 
-docs: test/Manifest.toml ## Build the documentation
-	$(JULIA) --project=test docs/make.jl
+docs/Manifest.toml:
+	$(JULIA) --project=docs --banner=no --startup-file=yes -e 'import Pkg; Pkg.instantiate()'
+
+docs: docs/Manifest.toml ## Build the documentation
+	$(JULIA) --project=docs docs/make.jl
 	@echo "Done. Consider using 'make devrepl'"
 
 pdf: test/Manifest.toml ## Build the documentation in PDF format

README.md

@@ -9,7 +9,7 @@
 
 [DocumenterCitations.jl](https://github.com/JuliaDocs/DocumenterCitations.jl#readme) uses [Bibliography.jl](https://github.com/Humans-of-Julia/Bibliography.jl) to add support for BibTeX citations in documentation pages generated by [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl).
 
-By default, [DocumenterCitations.jl](https://github.com/JuliaDocs/DocumenterCitations.jl#readme) uses a numeric citation style common in the natural sciences, see e.g. the [journals of the American Physical Society](https://journals.aps.org), and the [REVTeX author's guide](https://www.ctan.org/tex-archive/macros/latex/contrib/revtex/auguide).  Citations are shown in-line, as a number enclosed in square brackets, e.g., "Optimal control is a cornerstone in the development of quantum technologies [[1](#screenshot)]."
+By default, [DocumenterCitations.jl](https://github.com/JuliaDocs/DocumenterCitations.jl#readme) uses a numeric citation style common in the natural sciences, see e.g. the [journals of the American Physical Society](https://journals.aps.org/all_journals), and the [REVTeX author's guide](https://www.ctan.org/tex-archive/macros/latex/contrib/revtex/auguide).  Citations are shown in-line, as a number enclosed in square brackets, e.g., "Optimal control is a cornerstone in the development of quantum technologies [[1](#screenshot)]."
 
 
 <img id="screenshot" src="docs/src/assets/references.png" alt="Rendered bibliography of two references, [1] and [2]" width="830px">
@@ -25,7 +25,7 @@ The `DocumenterCitations` package can be installed with [Pkg](https://pkgdocs.ju
 pkg> add DocumenterCitations
 ~~~
 
-In most cases, you will just want to have `DocumenterCitations` in the project that builds your documentation (e.g. [`test/Project.toml`](https://github.com/JuliaDocs/DocumenterCitations.jl/blob/master/test/Project.toml)). Thus, you can also simply add
+In most cases, you will just want to have `DocumenterCitations` in the project that builds your documentation (e.g. [`docs/Project.toml`](https://github.com/JuliaDocs/DocumenterCitations.jl/blob/master/docs/Project.toml)). Thus, you can also simply add
 
 ```
 DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"

docs/Project.toml

@@ -0,0 +1,12 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
+DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
+Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+
+[sources]
+DocumenterCitations = {path = ".."}
+
+[compat]
+Documenter = "1.4"
+julia = "1.11"

docs/src/index.md

@@ -28,7 +28,7 @@ end
 
 [DocumenterCitations.jl](https://github.com/JuliaDocs/DocumenterCitations.jl#readme) uses [Bibliography.jl](https://github.com/Humans-of-Julia/Bibliography.jl) to add support for BibTeX citations in documentation pages generated by [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl).
 
-By default, [DocumenterCitations.jl](https://github.com/JuliaDocs/DocumenterCitations.jl#readme) uses a numeric citation style common in the natural sciences, see e.g. the [journals of the American Physical Society](https://journals.aps.org), and the [REVTeX author's guide](https://www.ctan.org/tex-archive/macros/latex/contrib/revtex/auguide). Citations are shown in-line, as a number enclosed in square brackets, e.g., "Optimal control is a cornerstone in the development of quantum technologies [BrifNJP2010](@cite)". [Alternative styles](@ref gallery) are supported, including an [author-year style](@ref author_year_style).
+By default, [DocumenterCitations.jl](https://github.com/JuliaDocs/DocumenterCitations.jl#readme) uses a numeric citation style common in the natural sciences, see e.g. the [journals of the American Physical Society](https://journals.aps.org/all_journals), and the [REVTeX author's guide](https://www.ctan.org/tex-archive/macros/latex/contrib/revtex/auguide). Citations are shown in-line, as a number enclosed in square brackets, e.g., "Optimal control is a cornerstone in the development of quantum technologies [BrifNJP2010](@cite)". [Alternative styles](@ref gallery) are supported, including an [author-year style](@ref author_year_style).
 
 ## Installation instructions
 
@@ -38,7 +38,7 @@ You can install the latest version of [DocumenterCitations.jl](https://github.co
 pkg> add DocumenterCitations
 ```
 
-In most cases, you will just want to have `DocumenterCitations` in the project that builds your documentation (e.g. [`test/Project.toml`](https://github.com/JuliaDocs/DocumenterCitations.jl/blob/master/test/Project.toml)). Thus, you can also simply add
+In most cases, you will just want to have `DocumenterCitations` in the project that builds your documentation (e.g. [`docs/Project.toml`](https://github.com/JuliaDocs/DocumenterCitations.jl/blob/master/docs/Project.toml)). Thus, you can also simply add
 
 ```
 DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
@@ -137,7 +137,7 @@ The following is a list of some projects that use `DocumenterCitations`:
 * [QuantumPropagators](https://juliaquantumcontrol.github.io/QuantumPropagators.jl/)
 * [QuantumControl](https://juliaquantumcontrol.github.io/QuantumControl.jl/)
 * [TwoQubitWeylChamber](https://juliaquantumcontrol.github.io/TwoQubitWeylChamber.jl/)
-* [QuantumClifford](https://quantumsavory.github.io/QuantumClifford.jl/stable/references/) and the parent [QuantumSavory organization](https://github.com/QuantumSavory)
+* [QuantumClifford](https://qc.quantumsavory.org/stable/references/) and the parent [QuantumSavory organization](https://github.com/QuantumSavory)
 
 ## Home References
 

test/clean.jl

@@ -35,7 +35,6 @@ function clean(; distclean=false, _exit=true)
     for folder in ["", "docs", "test"]
         _push!(DISTCLEAN, joinpath(joinpath(ROOT, folder), "Manifest.toml"))
     end
-    _push!(DISTCLEAN, joinpath(ROOT, "docs", "Project.toml"))
     ###########################################################################
 
     for name in CLEAN