Skip to content

Commit 3583abe

Browse files
authored
Fix docs deploy (#138)
* Fix docs deploy: * Fix documentation, assets, add methods
1 parent 5022624 commit 3583abe

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

docs/make.jl

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ makedocs(
66
sitename="TranscodingStreams.jl",
77
modules=[TranscodingStreams],
88
pages=["index.md", "examples.md", "reference.md", "devnotes.md"],
9-
assets=["assets/custom.css"],
9+
format=Documenter.HTML(; assets=["assets/custom.css"]),
1010
)
1111

12-
deploydocs(repo="github.com/bicycle1885/TranscodingStreams.jl.git")
12+
deploydocs(repo="github.com/JuliaIO/TranscodingStreams.jl.git", push_preview=true)

docs/src/reference.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,10 @@ TranscodingStream
1010

1111
```@docs
1212
TranscodingStream(codec::Codec, stream::IO)
13-
transcode(::Type{<:Codec}, data::ByteData)
14-
transcode(codec::Codec, data::ByteData)
13+
transcode(::Type{C}, args...) where {C<:Codec}
14+
transcode(::Codec, ::Buffer, ::Union{Buffer,Nothing})
15+
16+
TranscodingStreams.transcode!
1517
TranscodingStreams.TOKEN_END
1618
TranscodingStreams.unsafe_read
1719
TranscodingStreams.unread
@@ -33,6 +35,7 @@ Codec
3335
```@docs
3436
TranscodingStreams.Noop
3537
TranscodingStreams.NoopStream
38+
Base.position(::NoopStream)
3639
```
3740

3841
```@docs

0 commit comments

Comments
 (0)