Skip to content

Commit 1c7b04d

Browse files
authored
fix doc rendering (#8)
* fix doc rendering * Update doc script
1 parent 7ead318 commit 1c7b04d

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

.github/workflows/documentation.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ jobs:
1111
build:
1212
runs-on: ubuntu-latest
1313
steps:
14-
- uses: actions/checkout@v2
14+
- uses: actions/checkout@v4
1515
- uses: julia-actions/setup-julia@latest
1616
with:
17-
version: '1.6'
17+
version: '1.10'
1818
- name: Install dependencies
1919
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
2020
- name: Build and deploy
2121
env:
2222
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
2323
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
24-
run: julia --project=docs/ docs/make.jl
24+
run: julia --project=docs/ docs/make.jl

Readme.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ end
4545

4646
[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
4747
[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
48-
[docs-stable-url]: https://juliaalgebra.github.io/TrigPolys.jl/dev/
49-
[docs-latest-url]: https://juliaalgebra.github.io/TrigPolys.jl/dev/
48+
[docs-stable-url]: https://juliaalgebra.github.io/TrigPolys.jl/stable
49+
[docs-latest-url]: https://juliaalgebra.github.io/TrigPolys.jl/dev
5050

51-
[build-img]: https://github.com/JuliaAlgebra/TrigPolys.jl/actions/workflows/ci.yml/badge.svg?branch=master
51+
[build-img]: https://github.com/JuliaAlgebra/TrigPolys.jl/actions/workflows/CI.yml/badge.svg?branch=master
5252
[build-url]: https://github.com/JuliaAlgebra/TrigPolys.jl/actions?query=workflow%3ACI
5353
[codecov-img]: https://codecov.io/gh/JuliaAlgebra/TrigPolys.jl/branch/master/graph/badge.svg
5454
[codecov-url]: https://codecov.io/gh/JuliaAlgebra/TrigPolys.jl/branch/master

docs/src/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# TrigPolys
22

3-
[TrigPolys.jl](https://github.com/yuanchenyang/TrigPolys.jl) is a package for
3+
[TrigPolys.jl](https://github.com/JuliaAlgebra/TrigPolys.jl) is a package for
44
fast manipulation of trigonometric polynomials.
55

66
A *Hermitian trigonometric polynomial*
7-
can be viewed as a polynomial `R(z) \\in \\mathbb{C}[z]` [D17, (1.7)]:
7+
can be viewed as a polynomial ``R(z) \in \mathbb{C}[z]`` [D17, (1.7)]:
88
```math
9-
R(z) = a_0 + \\frac{1}{2} \\sum_{k=1}^n a_k z^{-k} + a_k^* z^k
9+
R(z) = a_0 + \frac{1}{2} \sum_{k=1}^n a_k z^{-k} + a_k^* z^k
1010
```
1111
On the unit circle, this becomes [D17, (1.8)]:
1212
```math
13-
R(\\omega) = a_0 + \\sum_{k=1}^n a_{c,k} \\cos(k\\omega) + a_{s,k} \\sin(k\\omega)
13+
R(\omega) = a_0 + \sum_{k=1}^n a_{c,k} \cos(k\omega) + a_{s,k} \sin(k\omega)
1414
```
1515
where ``a_{c,k}`` is `ac[k]` and ``a_{s,k}`` is `as[k]`.
1616

0 commit comments

Comments
 (0)