mirror of
https://github.com/MillironX/SequenceVariation.jl.git
synced 2024-11-22 13:29:56 +00:00
Update documentation
This commit is contained in:
parent
4ef7ba4450
commit
3d03740741
GPG key ID:
139C07724802BC5D
4 changed files with 103 additions and 10 deletions
|
|
@ -1,2 +1,6 @@
|
|||
[deps]
|
||||
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
|
||||
Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
|
||||
|
||||
[compat]
|
||||
Documenter = "0.27"
|
||||
|
|
|
|||
25
docs/make.jl
25
docs/make.jl
|
|
@ -1,15 +1,22 @@
|
|||
using Pkg
|
||||
using Documenter
|
||||
using SequenceVariation
|
||||
|
||||
makedocs(
|
||||
sitename = "SequenceVariation",
|
||||
makedocs(;
|
||||
checkdocs = :exports,
|
||||
linkcheck = true,
|
||||
sitename = "SequenceVariation.jl",
|
||||
format = Documenter.HTML(),
|
||||
modules = [SequenceVariation]
|
||||
modules = [SequenceVariation],
|
||||
pages = [
|
||||
"Home" => "index.md",
|
||||
"API Reference" => "api.md",
|
||||
],
|
||||
authors = replace(join(Pkg.TOML.parsefile("Project.toml")["authors"], ", "), r" <.*?>" => "" ) * ", The BioJulia Organisation, and other contributors."
|
||||
)
|
||||
|
||||
# Documenter can also automatically deploy documentation to gh-pages.
|
||||
# See "Hosting Documentation" and deploydocs() in the Documenter manual
|
||||
# for more information.
|
||||
#=deploydocs(
|
||||
repo = "<repository url>"
|
||||
)=#
|
||||
deploydocs(
|
||||
repo = "github.com/BioJulia/SequenceVariation.jl.git",
|
||||
devbranch = "master",
|
||||
push_preview = true,
|
||||
)
|
||||
|
|
|
|||
12
docs/src/api.md
Normal file
12
docs/src/api.md
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
```@meta
|
||||
CurrentModule = SequenceVariation
|
||||
DocTestSetup = quote
|
||||
using SequenceVariation
|
||||
end
|
||||
```
|
||||
|
||||
# API Reference
|
||||
|
||||
```@autodocs
|
||||
Modules = SequenceVariation
|
||||
```
|
||||
|
|
@ -1,3 +1,73 @@
|
|||
# SequenceVariation.jl
|
||||
|
||||
Documentation for SequenceVariation.jl
|
||||
[](https://www.repostatus.org/#wip)
|
||||
[](https://github.com/BioJulia/SequenceVariation.jl/releases/latest)
|
||||
[](https://github.com/BioJulia/SequenceVariation.jl/blob/master/LICENSE)
|
||||
[](https://biojulia.github.io/SequenceVariation.jl/stable)
|
||||
[](https://biojulia.github.io/SequenceVariation.jl/dev/)
|
||||
|
||||
> This project follows the [semver](https://semver.org) _pro forma_ and uses the [OneFlow branching model](https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow).
|
||||
|
||||
## Description
|
||||
|
||||
SequenceVariation provides a Julia vocabulary for comparing genetic mutations within biological sequences.
|
||||
|
||||
## Installation
|
||||
|
||||
You can install SequenceVariation from the [Julia REPL](https://docs.julialang.org/en/v1/manual/getting-started/).
|
||||
Press `]` to enter [pkg mode](https://docs.julialang.org/en/v1/stdlib/Pkg/), and enter the following:
|
||||
|
||||
```julia
|
||||
add https://github.com/SequenceVariation.jl
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
SequenceVariation is tested against Julia `1.X` on Linux, OS X, and Windows.
|
||||
|
||||
**Latest build status:**
|
||||
|
||||
[](https://github.com/BioJulia/SequenceVariation.jl/actions?query=workflow%3A%22Unit+tests%22+branch%3Amaster)
|
||||
[](https://github.com/BioJulia/SequenceVariation.jl/actions?query=workflow%3ADocumentation+branch%3Amaster)
|
||||
[](https://codecov.io/gh/BioJulia/SequenceVariation.jl)
|
||||
|
||||
## Contributing
|
||||
|
||||
We appreciate [contributions](https://github.com/BioJulia/SequenceVariation.jl/graphs/contributors) from users including reporting bugs, fixing issues, improving performance and adding new features.
|
||||
|
||||
Take a look at the [contributing files](https://github.com/BioJulia/Contributing) for detailed contributor and maintainer guidelines, and code of conduct.
|
||||
|
||||
### Financial contributions
|
||||
|
||||
We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/biojulia).
|
||||
Anyone can file an expense.
|
||||
If the expense makes sense for the development the core contributors and the person who filed the expense will be reimbursed.
|
||||
|
||||
|
||||
## Backers & Sponsors
|
||||
|
||||
Thank you to all our backers and sponsors!
|
||||
|
||||
Love our work and community? [Become a backer](https://opencollective.com/biojulia#backer).
|
||||
|
||||
[](https://opencollective.com/biojulia#backers)
|
||||
|
||||
Does your company use BioJulia?
|
||||
Help keep BioJulia feature rich and healthy by [sponsoring the project](https://opencollective.com/biojulia#sponsor).
|
||||
Your logo will show up here with a link to your website.
|
||||
|
||||
[](https://opencollective.com/biojulia/sponsor/0/website)
|
||||
[](https://opencollective.com/biojulia/sponsor/1/website)
|
||||
[](https://opencollective.com/biojulia/sponsor/2/website)
|
||||
[](https://opencollective.com/biojulia/sponsor/3/website)
|
||||
[](https://opencollective.com/biojulia/sponsor/4/website)
|
||||
[](https://opencollective.com/biojulia/sponsor/5/website)
|
||||
[](https://opencollective.com/biojulia/sponsor/6/website)
|
||||
[](https://opencollective.com/biojulia/sponsor/7/website)
|
||||
[](https://opencollective.com/biojulia/sponsor/8/website)
|
||||
[](https://opencollective.com/biojulia/sponsor/9/website)
|
||||
|
||||
|
||||
## Questions?
|
||||
|
||||
If you have a question about contributing or using BioJulia software, come on over and chat to us on [the Julia Slack workspace](https://julialang.org/slack/), or you can try the [Bio category of the Julia discourse site](https://discourse.julialang.org/c/domain/bio).
|
||||
|
|
|
|||
Loading…
Reference in a new issue