Skip to content

DocumenterCitations #14

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DocumenterCitations #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[deps]
AlgebraicTemplate = "b66562e1-fa90-4e8b-9505-c909188fab76"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
18 changes: 11 additions & 7 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Documenter
using DocumenterCitations
using Literate

const literate_dir = joinpath(@__DIR__, "literate")
Expand Down Expand Up @@ -32,6 +33,10 @@ if !no_literate
end
end

bib = CitationBibliography(
joinpath(@__DIR__, "src", "documenter.bib");
style=:numeric)

@info "Building Documenter.jl docs"
makedocs(
modules=[AlgebraicTemplate],
Expand All @@ -42,15 +47,14 @@ makedocs(
pages=Any[
"AlgebraicTemplate.jl"=>"index.md",
"Examples"=>Any[
"generated/literate_example.md",
],
"Library Reference"=>"api.md",
]
)
"generated/literate_example.md",],
"Library Reference"=>"api.md",],
plugins=[bib])


@info "Deploying docs"
deploydocs(
target="build",
repo="github.com/AlgebraicJulia/AlgebraicTemplate.jl.git",
branch="gh-pages"
)
branch="gh-pages")

9 changes: 9 additions & 0 deletions docs/src/documenter.bib
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

@article{glen_flow_1958,
title = {The flow law of ice: {A} discussion of the assumptions made in glacier theory, their experimental foundations and consequences},
volume = {47},
journal = {IASH Publ},
author = {Glen, JW},
year = {1958},
pages = {171--183},
}