Skip to content

Commit

Permalink
docs: drop sphinx and use doxygen exclusively
Browse files Browse the repository at this point in the history
  • Loading branch information
ReenigneArcher committed Jul 30, 2024
1 parent 459c604 commit 88f24f5
Show file tree
Hide file tree
Showing 19 changed files with 113 additions and 512 deletions.
6 changes: 1 addition & 5 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -335,9 +335,7 @@ jobs:
libxcb1-dev \
libxfixes-dev \
libxrandr-dev \
libxtst-dev \
python3 \
python3-venv
libxtst-dev
# clean apt cache
sudo apt-get clean
Expand Down Expand Up @@ -1101,7 +1099,6 @@ jobs:
Remove-Item -Path doxygen-setup.exe
- name: Setup python
# use this instead of msys2 python due to known issues using wheels, https://www.msys2.org/docs/python/
id: setup-python
uses: actions/setup-python@v5
with:
Expand Down Expand Up @@ -1130,7 +1127,6 @@ jobs:
cmake \
-DBUILD_WERROR=ON \
-DCMAKE_BUILD_TYPE=RelWithDebInfo \
-DPython_EXECUTABLE='${{ steps.python-path.outputs.python-path }}' \
-DSUNSHINE_ASSETS_DIR=assets \
-DTESTS_SOFTWARE_ENCODER_UNAVAILABLE='skip' \
-G "MinGW Makefiles" \
Expand Down
28 changes: 7 additions & 21 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,33 +11,19 @@ build:
os: ubuntu-24.04
tools:
python: "miniconda-latest"
apt_packages:
- libboost-locale-dev # required for rstcheck in cpp code block
jobs:
post_build:
- find ./third-party -iname "*.rst" -type f -delete # find and delete rst files in third-party
- rstcheck -r . # lint rst files
# - rstfmt --check --diff -w 120 . # check rst formatting
commands:
# because we are overriding the build commands, we need to setup the environment ourselves
- cat docs/environment.yml
- conda env create --quiet --name $READTHEDOCS_VERSION --file docs/environment.yml
- echo 'OUTPUT_DIRECTORY = ../_readthedocs' >> ./docs/Doxyfile
- echo 'PROJECT_NUMBER = $READTHEDOCS_VERSION' >> ./docs/Doxyfile
- cd docs && doxygen Doxyfile

# using conda, we can get newer doxygen and graphviz than ubuntu provide
# https://github.com/readthedocs/readthedocs.org/issues/8151#issuecomment-890359661
conda:
environment: docs/environment.yml

# submodules required for include statements
submodules:
include: all
recursive: true

# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
configuration: docs/source/conf.py
fail_on_warning: true

# Using Sphinx, build docs in additional formats
formats: all

python:
install:
- requirements: ./docs/requirements.txt
72 changes: 72 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Overview

[![GitHub stars](https://img.shields.io/github/stars/lizardbyte/sunshine.svg?logo=github&style=for-the-badge)](https://github.com/LizardByte/Sunshine)
[![GitHub Releases](https://img.shields.io/github/downloads/lizardbyte/sunshine/total.svg?style=for-the-badge&logo=github)](https://github.com/LizardByte/Sunshine/releases/latest)
[![Docker](https://img.shields.io/docker/pulls/lizardbyte/sunshine.svg?style=for-the-badge&logo=docker)](https://hub.docker.com/r/lizardbyte/sunshine)
[![GHCR](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fipitio%2Fghcr-pulls%2Fmaster%2Findex.json&query=%24%5B%3F(%40.owner%3D%3D%22LizardByte%22%20%26%26%20%40.repo%3D%3D%22Sunshine%22%20%26%26%20%40.image%3D%3D%22sunshine%22)%5D.pulls&label=ghcr%20pulls&style=for-the-badge&logo=github)](https://github.com/LizardByte/Sunshine/pkgs/container/sunshine)
[![Winget Version](https://img.shields.io/badge/dynamic/json.svg?color=orange&label=Winget&style=for-the-badge&prefix=v&query=$[-1:].name&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fmicrosoft%2Fwinget-pkgs%2Fcontents%2Fmanifests%2Fl%2FLizardByte%2FSunshine&logo=microsoft)](https://github.com/microsoft/winget-pkgs/tree/master/manifests/l/LizardByte/Sunshine)
[![GitHub Workflow Status (CI)](https://img.shields.io/github/actions/workflow/status/lizardbyte/sunshine/CI.yml.svg?branch=master&label=CI%20build&logo=github&style=for-the-badge)](https://github.com/LizardByte/Sunshine/actions/workflows/CI.yml?query=branch%3Amaster)
[![GitHub Workflow Status (localize)](https://img.shields.io/github/actions/workflow/status/lizardbyte/sunshine/localize.yml.svg?branch=master&label=localize%20build&logo=github&style=for-the-badge)](https://github.com/LizardByte/Sunshine/actions/workflows/localize.yml?query=branch%3Amaster)
[![Read the Docs](https://img.shields.io/readthedocs/sunshinestream.svg?label=Docs&style=for-the-badge&logo=readthedocs)](http://sunshinestream.readthedocs.io/)
[![Codecov](https://img.shields.io/codecov/c/gh/LizardByte/Sunshine?token=SMGXQ5NVMJ&style=for-the-badge&logo=codecov&label=codecov)](https://codecov.io/gh/LizardByte/Sunshine)

LizardByte has the full documentation hosted on [Read the Docs](https://sunshinestream.readthedocs.io/).

## About

Sunshine is a self-hosted game stream host for Moonlight.
Offering low latency, cloud gaming server capabilities with support for AMD, Intel, and Nvidia GPUs for hardware
encoding. Software encoding is also available. You can connect to Sunshine from any Moonlight client on a variety of
devices. A web UI is provided to allow configuration, and client pairing, from your favorite web browser. Pair from
the local server or any mobile device.

## System Requirements

> [!WARNING]
> This table is a work in progress. Do not purchase hardware based on this.
### Minimum Requirements

| Component | Requirement |
|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| GPU | AMD: VCE 1.0 or higher, see: [obs-amd hardware support](https://github.com/obsproject/obs-amd-encoder/wiki/Hardware-Support) |
| | Intel: VAAPI-compatible, see: [VAAPI hardware support](https://www.intel.com/content/www/us/en/developer/articles/technical/linuxmedia-vaapi.html) |
| | Nvidia: NVENC enabled cards, see: [nvenc support matrix](https://developer.nvidia.com/video-encode-and-decode-gpu-support-matrix-new) |
| CPU | AMD: Ryzen 3 or higher |
| | Intel: Core i3 or higher |
| RAM | 4GB or more |
| OS | Windows: 10+ (Windows Server does not support virtual gamepads) |
| | macOS: 12+ |
| | Linux/Debian: 12+ (bookworm) |
| | Linux/Fedora: 39+ |
| | Linux/Ubuntu: 22.04+ (jammy) |
| Network | Host: 5GHz, 802.11ac |
| | Client: 5GHz, 802.11ac |

### 4k Suggestions

| Component | Requirement |
|-----------|----------------------------------------|
| GPU | AMD: Video Coding Engine 3.1 or higher |
| | Intel: HD Graphics 510 or higher |
| | Nvidia: GeForce GTX 1080 or higher |
| CPU | AMD: Ryzen 5 or higher |
| | Intel: Core i5 or higher |
| Network | Host: CAT5e ethernet or better |
| | Client: CAT5e ethernet or better |

### HDR Suggestions

| Component | Requirement |
|-----------|----------------------------------------------------|
| GPU | AMD: Video Coding Engine 3.4 or higher |
| | Intel: UHD Graphics 730 or higher |
| | Nvidia: Pascal-based GPU (GTX 10-series) or higher |
| CPU | AMD: Ryzen 5 or higher |
| | Intel: Core i5 or higher |
| Network | Host: CAT5e ethernet or better |
| | Client: CAT5e ethernet or better |

## Support

Our support methods are listed in our [LizardByte Docs](https://lizardbyte.readthedocs.io/en/latest/about/support.html).
111 changes: 0 additions & 111 deletions README.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docker/clion-toolchain.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,6 @@ apt-get install -y --no-install-recommends \
libxfixes-dev \
libxrandr-dev \
libxtst-dev \
python3.10 \
python3.10-venv \
udev \
wget \
x11-xserver-utils \
Expand Down
2 changes: 0 additions & 2 deletions docker/debian-bookworm.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,6 @@ apt-get install -y --no-install-recommends \
libxtst-dev \
nodejs \
npm \
python3.11 \
python3.11-venv \
udev \
wget \
x11-xserver-utils \
Expand Down
1 change: 0 additions & 1 deletion docker/fedora-40.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ dnf -y install \
openssl-devel \
opus-devel \
pulseaudio-libs-devel \
python3.11 \
rpm-build \
wget \
which \
Expand Down
2 changes: 0 additions & 2 deletions docker/ubuntu-22.04.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,6 @@ apt-get install -y --no-install-recommends \
libxfixes-dev \
libxrandr-dev \
libxtst-dev \
python3.10 \
python3.10-venv \
udev \
wget \
x11-xserver-utils \
Expand Down
2 changes: 0 additions & 2 deletions docker/ubuntu-24.04.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,6 @@ apt-get install -y --no-install-recommends \
libxfixes-dev \
libxrandr-dev \
libxtst-dev \
python3.12 \
python3.12-venv \
udev \
wget \
x11-xserver-utils \
Expand Down
Loading

0 comments on commit 88f24f5

Please sign in to comment.