Skip to content

Commit

Permalink
Merge pull request #102 from Chemellia/fix_docs
Browse files Browse the repository at this point in the history
fix docs
  • Loading branch information
rkurchin authored Feb 24, 2022
2 parents 7d9d4da + e8d1c77 commit c3bfaf0
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 15 deletions.
7 changes: 5 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
Manifest.toml
*~
playing.jl
*/api_key_is*
examples/*/data/
*#
Expand All @@ -9,4 +8,8 @@ Icon*
*/Icon*
*/*/Icon*
build
*.jls
*.jls

# Build artifacts for creating documentation generated by the Documenter package
docs/build/
docs/site/
46 changes: 33 additions & 13 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,29 @@ if haskey(ENV, "DOCSARGS")
end
end

pages = Any[
"Home"=>"index.md",
"Basic Graph Theory"=>"graph_theory.md",
"GCNNs"=>"gcnns.md",
"Comparison with cgcnn.py"=>"comparison.md",
"Examples"=>Any[
"Example 1"=>"examples/example_1.md",
],
"Functions"=>Any[
"Layers"=>"functions/layers.md",
"Models"=>"functions/models.md"
],
"Changelog"=>"changelog.md",
]

makedocs(
sitename = "AtomicGraphNets.jl",
modules = [AtomicGraphNets],
pages = Any[
"Home"=>"index.md",
"Basic Graph Theory"=>"graph_theory.md",
"GCNNs"=>"gcnns.md",
"Comparison with cgcnn.py"=>"comparison.md",
"Examples"=>Any[
"Example 1"=>"examples/example_1.md",
"Example 2"=>"examples/example_2.md",
],
"Functions"=>Any["Layers"=>"functions/layers.md", "Models"=>"functions/models.md"],
"Changelog"=>"changelog.md",
],
pages = pages,
format = Documenter.HTML(
# Use clean URLs, unless built as a "local" build
prettyurls = !("local" in ARGS),
canonical = "https://aced-differentiate.github.io/AtomicGraphNets.jl/stable/",
canonical = "https://chemellia.github.io/AtomicGraphNets.jl/stable/",
edit_link = "main",
),
linkcheck = "linkcheck" in ARGS,
Expand All @@ -40,3 +44,19 @@ deploydocs(
devbranch = "main",
push_preview = true,
)

# for local build
"""
makedocs(
sitename = "AtomicGraphNets.jl",
modules = [AtomicGraphNets],
pages = pages,
format = Documenter.HTML(
# Use clean URLs, unless built as a "local" build
prettyurls = false,
canonical = "https://chemellia.github.io/AtomicGraphNets.jl/stable/",
edit_link = "main",
),
linkcheck = "linkcheck" in ARGS,
)
"""

2 comments on commit c3bfaf0

@rkurchin
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/55385

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.2.3 -m "<description of version>" c3bfaf0e0f09da15ceb2cc6dd4093e8df25ce0c7
git push origin v0.2.3

Please sign in to comment.