More doc fixes

BioJulia · Aug 9, 2022 · e0d9b64 · e0d9b64
1 parent 1117882
commit e0d9b64
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 2 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -0,0 +1,7 @@
+[deps]
+BioSequences = "7e6ae17a-c86d-528c-b3b9-7f778a29fe59"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+
+[compat]
+BioSequences = "3"
+Documenter = "0.27" 
diff --git a/docs/src/fai.md b/docs/src/fai.md
@@ -131,4 +131,12 @@ julia> extract(reader, "seq1", 3:5)
 DocTestSetup = nothing
 ```
 
-FASTX.jl does not yet support indexing FASTQ files.
+FASTX.jl does not yet support indexing FASTQ files.
+
+### Reference:
+```@docs
+faidx
+seekrecord
+extract
+Index
+```
diff --git a/docs/src/fasta.md b/docs/src/fasta.md
@@ -55,4 +55,5 @@ Else, it will wrap lines to the given maximal width.
 ```@docs
 FASTA.Reader
 FASTA.Writer
+validate_fasta
 ```
diff --git a/docs/src/fastq.md b/docs/src/fastq.md
@@ -112,6 +112,8 @@ QualityEncoding
 ### Reference:
 ```@docs
 quality
+quality_scores
+quality_header!
 ```
 
 ## `FASTQReader` and `FASTQWriter`
@@ -124,4 +126,5 @@ If set to a `Bool` value, the `Writer` will override the `Records`, without chan
 ```@docs
 FASTQ.Reader
 FASTQ.Writer
+validate_fastq
 ```
diff --git a/docs/src/records.md b/docs/src/records.md
@@ -56,3 +56,8 @@ UGCCCA
 julia> sequence(String, record)
 "UGCCCA"
 ```
+
+### Reference:
+```@docs
+FASTA.Record!
+```
diff --git a/src/fasta/index.jl b/src/fasta/index.jl
@@ -23,7 +23,7 @@ Note that the FAI specs are stricter than FASTX.jl's definition of FASTA,
 such that some valid FASTA records may not be indexable.
 See the specs at: http://www.htslib.org/doc/faidx.html
 
-See also: [FASTA.Reader](@ref)
+See also: [`FASTA.Reader`](@ref)
 
 # Examples
 ```jldoctest