From ca4b82e0d92cc2e90dd8793a8dd7fca572fd4834 Mon Sep 17 00:00:00 2001 From: XargonWan Date: Tue, 29 Aug 2023 09:13:55 +0200 Subject: [PATCH] Initializing ReadTheDocs [skip ci] --- .gitmodules | 3 +++ .readthedocs.yaml | 4 ++-- docs/conf.py | 28 ---------------------------- docs/requirements.txt | 2 -- wiki | 1 + 5 files changed, 6 insertions(+), 32 deletions(-) delete mode 100644 docs/conf.py delete mode 100644 docs/requirements.txt create mode 160000 wiki diff --git a/.gitmodules b/.gitmodules index 03419e80..af401b32 100644 --- a/.gitmodules +++ b/.gitmodules @@ -4,3 +4,6 @@ [submodule "rd-submodules/shared-modules"] path = rd-submodules/shared-modules url = https://github.com/flathub/shared-modules.git +[submodule "wiki"] + path = wiki + url = https://github.com/XargonWan/RetroDECK.wiki.git diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 557862cb..82aae0bd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -16,7 +16,7 @@ build: # Build documentation in the "docs/" directory with Sphinx sphinx: - configuration: docs/conf.py + configuration: wiki/conf.py # Optionally build your docs in additional formats such as PDF and ePub formats: @@ -28,4 +28,4 @@ formats: # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - - requirements: docs/requirements.txt \ No newline at end of file + - requirements: wiki/requirements.txt \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 99ba8c71..00000000 --- a/docs/conf.py +++ /dev/null @@ -1,28 +0,0 @@ -project = 'RetroDECK' -author = 'RetroDECK Team' - -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.doctest', - 'sphinx.ext.intersphinx', - 'sphinx.ext.todo', - 'sphinx.ext.coverage', - 'sphinx.ext.mathjax', - 'sphinx.ext.ifconfig', - 'sphinx.ext.viewcode', - 'sphinx_rtd_theme', - 'myst_parser', -] - -language = 'English' -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] -html_theme = "sphinx_rtd_theme" - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -source_suffix = [".rst", ".md", ".html"] -# source_suffix = '.rst' - -# The master toctree document. -master_doc = "index" \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 06e83580..00000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -sphinx_rtd_theme -myst-parser \ No newline at end of file diff --git a/wiki b/wiki new file mode 160000 index 00000000..21c675af --- /dev/null +++ b/wiki @@ -0,0 +1 @@ +Subproject commit 21c675af9e8cfe8b0ac1442f777a340675933f53