Skip to content

Commit 6a1c8a0

Browse files
authored
- Enchance documenter footer with version and date (#9)
- Add additional instruction to copilot context
1 parent fb73b3e commit 6a1c8a0

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

.github/copilot-instructions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,10 @@ foot_of_line(P::Point, v::Vector, R::Point) -> Tuple(Point, Float64)
316316
- Use Markdown for explanations
317317
- After creating or editing a markdown document always review and fix all linting issues, unless the document is a configuration file of some kind
318318
- Follow the pattern of existing function documentation in src directory
319+
- When a new mathematical concept is introduced, add an external link to [MathWorld](https://mathworld.wolfram.com/) for that specific concept.
320+
- Compare multiple potential URLs to choose the most appropriate one
321+
- Avoid replacing working links with inferior alternatives
322+
- Always use fetch_webpage function to check the link is valid and points to the correct concept.
319323

320324
## Communication Patterns
321325

docs/make.jl

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
CI = get(ENV, "CI", nothing) == "true" || get(ENV, "GITHUB_TOKEN", nothing) !== nothing
2-
using DrWatson, Documenter
2+
using DrWatson, Documenter, Dates
33
using Linear_Algebra
44

55
@info "Building Documentation"
@@ -13,8 +13,10 @@ makedocs(;
1313
format = Documenter.HTML(
1414
prettyurls = CI,
1515
edit_link = "main",
16-
assets = ["assets/custom.css"]
17-
)
16+
assets = ["assets/custom.css"],
17+
inventory_version = "0.1.0",
18+
footer = "Powered by [Documenter.jl](https://documenter.jl) and the [Julia Programming Language](https://julialang.org) generated on $(Dates.format(Dates.now(), "yyyy-mm-dd HH:MM:ss"))"
19+
),
1820
)
1921

2022
@info "Deploying Documentation"

0 commit comments

Comments
 (0)