From 3fed2fc624dcca225a31015daba9c8c0486b3c18 Mon Sep 17 00:00:00 2001 From: cmoussa1 Date: Mon, 14 Oct 2024 10:21:22 -0700 Subject: [PATCH] README: add link to ReadTheDocs site Problem: The top-level README does not provide a link to flux-accounting's ReadTheDocs pages. Add a link. Add a ReadTheDocs badge for the build status of flux-accounting's documentation. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 506532de..d2162047 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ [![ci](https://github.com/flux-framework/flux-accounting/workflows/ci/badge.svg)](https://github.com/flux-framework/flux-accounting/actions?query=workflow%3A.github%2Fworkflows%2Fmain.yml) [![codecov](https://codecov.io/gh/flux-framework/flux-accounting/branch/master/graph/badge.svg)](https://codecov.io/gh/flux-framework/flux-accounting) +![docs](https://readthedocs.org/projects/flux-accounting/badge/?version=latest) _NOTE: The interfaces of flux-accounting are being actively developed and are not yet stable. The Github issue tracker is the primary way to communicate with @@ -54,6 +55,12 @@ mounting /Users/moussa1/src/flux-framework/flux-accounting as /usr/src [moussa1@docker-desktop src]$ ``` +### Documentation + +To see detailed documentation about installing, administering, and configuring +flux-accounting, please see our official +[documentation pages](https://flux-accounting.readthedocs.io/en/latest/index.html). + #### Release SPDX-License-Identifier: LGPL-3.0