Skip to content

Commit eaa3e72

Browse files
authored
Merge pull request #748 from SpecterOps/BED-5949
chores: append readthedocs config file to build content on Github
2 parents 56ec4b9 + d65fe0e commit eaa3e72

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

.readthedocs.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
version: 2
5+
6+
# Set the OS, Python version and other tools you might need
7+
build:
8+
os: ubuntu-22.04
9+
tools:
10+
python: "3.12"
11+
12+
# Build documentation in the "docs/" directory with Sphinx
13+
sphinx:
14+
configuration: docs/conf.py
15+
# # Fail on all warnings to avoid broken references
16+
# fail_on_warning: true
17+
python:
18+
install:
19+
- requirements: docs/requirements.txt

docs/requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Defining the exact version will make sure things don't break
2+
sphinx==5.3.0
3+
sphinx_rtd_theme==1.1.1
4+
sphinx-notfound-page==1.0.2

0 commit comments

Comments
 (0)