Skip to content
This repository has been archived by the owner on Jul 31, 2023. It is now read-only.

Commit

Permalink
Merge pull request #3 from manics/readme
Browse files Browse the repository at this point in the history
Add RTD link to README
  • Loading branch information
manics authored Sep 14, 2022
2 parents 9edc0b8 + 6e726b1 commit 5059e13
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,31 @@

[![Build](https://github.com/manics/rse-tre/actions/workflows/build.yml/badge.svg)](https://github.com/manics/rse-tre/actions/workflows/build.yml)
[![Documentation Status](https://readthedocs.org/projects/rse-tre-community/badge/?version=latest)](https://rse-tre-community.readthedocs.io/en/latest/?badge=latest)

https://rse-tre-community.readthedocs.io/

## Overview

This repository is published using [Read the Docs](https://rse-tre-community.readthedocs.io/).
The documentation is built with Sphinx, and written in [Markdown with the MyST Parser](https://myst-parser.readthedocs.io/).

To build this repository locally, create a Python environment and install the requirements:

```sh
cd docs
pip install -r requirements.txt
```

Then build the documentation:

```sh
make html
```

[pre-commit](https://pre-commit.com/) is used to check the documentation for common issues, and to auto-format all content.

To run pre-commit locally:

```sh
pre-commit run --all-files
```

0 comments on commit 5059e13

Please sign in to comment.