Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@jakobnissen
jakobnissen committed Jul 31, 2024
1 parent 708d528 commit 638d2ef
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 41 deletions.
4 changes: 2 additions & 2 deletions docs/Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[deps]
BED = "8e4a8c10-cb6b-11e8-08d2-83478d609d67"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"

[compat]
Documenter = "0.27"
Documenter = "1"
15 changes: 12 additions & 3 deletions docs/make.jl
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,31 @@
using Pkg
using TOML
using Documenter, BED

format = Documenter.HTML(
edit_link = "develop"
)

authors = let
project_path = joinpath(Base.pkgdir(BED), "Project.toml")
toml = TOML.parsefile(project_path)
authors_with_email = join(toml["authors"], ", ")
authors = replace(authors_with_email, r" <.*?>" => "")
authors * ", The BioJulia Organisation, and other contributors."
end


makedocs(
format = format,
checkdocs = :all,
linkcheck = true,
#linkcheck = true,
modules = [BED],
sitename = "BED.jl",
pages = [
"Home" => "index.md",
"BED" => "man/bed.md",
"API Reference" => "man/api.md"
],
authors = replace(join(Pkg.TOML.parsefile("Project.toml")["authors"], ", "), r" <.*?>" => "" ) * ", The BioJulia Organisation, and other contributors."
authors = authors,
)

deploydocs(
Expand Down
42 changes: 6 additions & 36 deletions docs/src/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Latest Release](https://img.shields.io/github/release/BioJulia/BED.jl.svg)](https://github.com/BioJulia/BED.jl/releases/latest)
[![MIT license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/BioJulia/BED.jl/blob/master/LICENSE)
[![Stable documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://biojulia.github.io/BED.jl/stable)
[![Latest documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://biojulia.github.io/BED.jl/dev/)
[![Stable documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://biojulia.dev/BED.jl/stable/)
[![Latest documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://biojulia.dev/BED.jl/dev/)

> This project follows the [semver](http://semver.org) pro forma and uses the [git-flow branching model](https://nvie.com/posts/a-successful-git-branching-model/ "original blog post").
> This project follows the [semver](https://semver.org) pro forma and uses the [git-flow branching model](https://nvie.com/posts/a-successful-git-branching-model/ "original blog post").
## Description
BED provides I/O and utilities for the [BED file format](https://samtools.github.io/hts-specs/BEDv1.pdf).
Expand All @@ -20,49 +20,19 @@ add BED

If you are interested in the cutting edge of the development, please check out the [develop branch](https://github.com/BioJulia/BED.jl/tree/develop) to try new features before release.


## Testing
BED is tested against Julia `1.X` on Linux, OS X, and Windows.
BED is tested against on the LTS version, and newest version of Julia on Linux, OS X, and Windows.

**Latest build status:**

[![Unit Tests](https://github.com/BioJulia/BED.jl/actions/workflows/UnitTests.yml/badge.svg)](https://github.com/BioJulia/BED.jl/actions/workflows/UnitTests.yml)
[![Documentation](https://github.com/BioJulia/BED.jl/actions/workflows/Documentation.yml/badge.svg)](https://github.com/BioJulia/BED.jl/actions/workflows/Documentation.yml)
[![codecov](https://codecov.io/gh/BioJulia/BED.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/BioJulia/BED.jl)
[![codecov](https://codecov.io/gh/BioJulia/BED.jl/branch/master/graph/badge.svg)](https://app.codecov.io/gh/BioJulia/BED.jl)

## Contributing
We appreciate [contributions](https://github.com/BioJulia/BED.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) 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).

[![backers](https://opencollective.com/biojulia/backers.svg?width=890)](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/avatar.svg)](https://opencollective.com/biojulia/sponsor/0/website)
[![](https://opencollective.com/biojulia/sponsor/1/avatar.svg)](https://opencollective.com/biojulia/sponsor/1/website)
[![](https://opencollective.com/biojulia/sponsor/2/avatar.svg)](https://opencollective.com/biojulia/sponsor/2/website)
[![](https://opencollective.com/biojulia/sponsor/3/avatar.svg)](https://opencollective.com/biojulia/sponsor/3/website)
[![](https://opencollective.com/biojulia/sponsor/4/avatar.svg)](https://opencollective.com/biojulia/sponsor/4/website)
[![](https://opencollective.com/biojulia/sponsor/5/avatar.svg)](https://opencollective.com/biojulia/sponsor/5/website)
[![](https://opencollective.com/biojulia/sponsor/6/avatar.svg)](https://opencollective.com/biojulia/sponsor/6/website)
[![](https://opencollective.com/biojulia/sponsor/7/avatar.svg)](https://opencollective.com/biojulia/sponsor/7/website)
[![](https://opencollective.com/biojulia/sponsor/8/avatar.svg)](https://opencollective.com/biojulia/sponsor/8/website)
[![](https://opencollective.com/biojulia/sponsor/9/avatar.svg)](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).
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/15).

2 comments on commit 638d2ef

@jakobnissen
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/112089

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.3.1 -m "<description of version>" 638d2eff576373310be4cb017764c5196deacacc
git push origin v0.3.1

Please sign in to comment.