Skip to content

Commit

Permalink
Add readthedocs.org suppport files
Browse files Browse the repository at this point in the history
Add .readthedocs.yaml, shield and docs/requirements.txt
  • Loading branch information
lpenz committed Aug 26, 2023
1 parent 79fd2fc commit a1f6414
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
15 changes: 15 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.11"
sphinx:
configuration: docs/conf.py
fail_on_warning: true
formats:
- pdf
python:
install:
- requirements: docs/requirements.txt
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[![CI](https://github.com/lpenz/disk-img-tool/actions/workflows/ci.yml/badge.svg)](https://github.com/lpenz/disk-img-tool/actions/workflows/ci.yml)
[![docs](https://readthedocs.org/projects/disk-img-tool/badge/?version=stable)](https://disk-img-tool.readthedocs.io/en/stable/?badge=stable)
[![coveralls](https://coveralls.io/repos/github/lpenz/disk-img-tool/badge.svg?branch=main)](https://coveralls.io/github/lpenz/disk-img-tool?branch=main)
[![PyPI](https://img.shields.io/pypi/v/disk-img-tool)](https://pypi.org/project/disk-img-tool/)
[![github](https://img.shields.io/github/v/release/lpenz/disk-img-tool?logo=github)](https://github.com/lpenz/disk-img-tool/releases)
Expand Down Expand Up @@ -100,7 +101,7 @@ Raspberry Pi installation image with a username (instead of the defaul

disk-img-tool can be installed via [pypi]:

```.sh
```
pip install disk-img-tool
```
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
myst-parser

0 comments on commit a1f6414

Please sign in to comment.