From bc5789af601e25e76cc1860666ead55f01469bca Mon Sep 17 00:00:00 2001
From: Zonoia <altlockg@gmail.com>
Date: Tue, 24 Oct 2023 11:11:14 +0200
Subject: [PATCH] MISC: Readthedocs configuration that redirects to this repo
 (#833)

---
 .readthedocs.yaml | 16 ++++++++++++++++
 doc/conf.py       | 34 ++++++++++++++++++++++++++++++++++
 doc/index.rst     |  5 +++++
 3 files changed, 55 insertions(+)
 create mode 100644 .readthedocs.yaml
 create mode 100644 doc/conf.py
 create mode 100644 doc/index.rst

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 000000000..2b260300a
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,16 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 000000000..6e70b8acc
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,34 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+# -- Project information -----------------------------------------------------
+
+project = 'Bitburner'
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+              ]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['*']
+exclude_patterns = ['doc/index.rst']
+
+# -- Options for HTML output -------------------------------------------------
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 000000000..40b655411
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,5 @@
+.. meta::
+   :http-equiv=Refresh: 0; url='https://github.com/bitburner-official/bitburner-src/blob/stable/src/Documentation/doc/index.md'
+
+This link is outdated as documentation for Bitburner has been migrated to an in-game menu, this page should have redirected you to the new location.
+You can also click `here to go to the game's documentation <https://github.com/bitburner-official/bitburner-src/blob/stable/src/Documentation/doc/index.md/>`_.