Skip to content

Commit 5baf71b

Browse files
benegeesloede
andauthored
Add stable docs badge (#105)
* add badge for stable docs to README and docs * add documentation section with links to README * Update README.md Co-authored-by: Michael Schlottke-Lakemper <michael@sloede.com> * Update README.md Co-authored-by: Michael Schlottke-Lakemper <michael@sloede.com> --------- Co-authored-by: Michael Schlottke-Lakemper <michael@sloede.com>
1 parent 5699860 commit 5baf71b

2 files changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# libtrixi
22

3+
[![Docs-stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://trixi-framework.github.io/libtrixi/stable)
34
[![Docs-dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://trixi-framework.github.io/libtrixi/dev)
45
[![Build Status](https://github.com/trixi-framework/libtrixi/workflows/CI/badge.svg)](https://github.com/trixi-framework/libtrixi/actions?query=workflow%3ACI)
56
[![Coveralls](https://coveralls.io/repos/github/trixi-framework/libtrixi/badge.svg)](https://coveralls.io/github/trixi-framework/libtrixi)
@@ -251,6 +252,11 @@ this. If you skip this step, everything will work as usual, but some things migh
251252
slightly slower.
252253

253254

255+
## Documentation
256+
Documentation for the current release can be found at https://trixi-framework.github.io/libtrixi,
257+
and for the current development version at https://trixi-framework.github.io/libtrixi/dev.
258+
259+
254260
## Authors
255261
Libtrixi was initiated by
256262
[Benedict Geihe](https://www.mi.uni-koeln.de/NumSim/)

docs/src/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# libtrixi
22

3+
[![Docs-stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://trixi-framework.github.io/libtrixi/stable)
34
[![Docs-dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://trixi-framework.github.io/libtrixi/dev)
45
[![Build Status](https://github.com/trixi-framework/libtrixi/workflows/CI/badge.svg)](https://github.com/trixi-framework/libtrixi/actions?query=workflow%3ACI)
56
[![Coveralls](https://coveralls.io/repos/github/trixi-framework/libtrixi/badge.svg)](https://coveralls.io/github/trixi-framework/libtrixi)

0 commit comments

Comments
 (0)