Initializing ReadTheDocs [skip ci]

This commit is contained in:
XargonWan 2023-08-29 09:13:55 +02:00
parent 36675cb5aa
commit ca4b82e0d9
5 changed files with 6 additions and 32 deletions

3
.gitmodules vendored
View file

@ -4,3 +4,6 @@
[submodule "rd-submodules/shared-modules"] [submodule "rd-submodules/shared-modules"]
path = rd-submodules/shared-modules path = rd-submodules/shared-modules
url = https://github.com/flathub/shared-modules.git url = https://github.com/flathub/shared-modules.git
[submodule "wiki"]
path = wiki
url = https://github.com/XargonWan/RetroDECK.wiki.git

View file

@ -16,7 +16,7 @@ build:
# Build documentation in the "docs/" directory with Sphinx # Build documentation in the "docs/" directory with Sphinx
sphinx: sphinx:
configuration: docs/conf.py configuration: wiki/conf.py
# Optionally build your docs in additional formats such as PDF and ePub # Optionally build your docs in additional formats such as PDF and ePub
formats: formats:
@ -28,4 +28,4 @@ formats:
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python: python:
install: install:
- requirements: docs/requirements.txt - requirements: wiki/requirements.txt

View file

@ -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"

View file

@ -1,2 +0,0 @@
sphinx_rtd_theme
myst-parser

1
wiki Submodule

@ -0,0 +1 @@
Subproject commit 21c675af9e8cfe8b0ac1442f777a340675933f53