godotengine/godot-contributing-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-contributing-docs.git synced 2025-12-31 05:48:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add extensions and roles from docs repo.

Browse Source
This commit is contained in:
Lukas Tenbrink
2025-08-19 16:24:42 +02:00
parent 2308325c4a
commit faf436009f
3 changed files with 65 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
404.rst Normal file
View File

@@ -0,0 +1,24 @@
:github_url: hide
:allow_comments: False
Page not found
==============
.. https://github.com/readthedocs/sphinx-notfound-page
.. raw:: html
<p>
Sorry, we couldn't find that page. It may have been renamed or removed
in the version of the documentation you're currently browsing.
</p>
<p>
If you're currently browsing the
<em>latest</em> version of the documentation, try browsing the
<a href="/en/stable/"><em>stable</em> version of the documentation</a>.
</p>
<p>
Alternatively, use the
<a href="#" onclick="$('#rtd-search-form [name=\\'q\\']').focus()">Search docs</a>
box on the left or <a href="/">go to the homepage</a>.
</p>

28
conf.py
View File

@@ -12,11 +12,11 @@ version = '0.1.0'
# -- General configuration # -- General configuration
extensions = [ extensions = [
'sphinx.ext.duration', "sphinx_tabs.tabs",
'sphinx.ext.doctest', "notfound.extension",
'sphinx.ext.autodoc', "sphinxext.opengraph",
'sphinx.ext.autosummary', "sphinx_copybutton",
'sphinx.ext.intersphinx', "sphinxcontrib.video",
] ]
intersphinx_mapping = { intersphinx_mapping = {
@@ -70,3 +70,21 @@ html_js_files = [
# -- Options for EPUB output # -- Options for EPUB output
epub_show_urls = 'footnote' epub_show_urls = 'footnote'
# -- Custom Sphinx roles for UI -------------------------------------------
rst_prolog = """
.. role:: button
:class: role-button role-ui
.. role:: menu
:class: role-menu role-ui
.. role:: inspector
:class: role-ui
.. role:: ui
:class: role-ui
"""

18
requirements.txt
View File

@@ -1,2 +1,20 @@
# Base dependencies
pygments==2.19.2
# Sphinx base and RTD theme.
sphinx==8.1.3 sphinx==8.1.3
sphinx_rtd_theme==3.0.2 sphinx_rtd_theme==3.0.2
# Sphinx extensions.
# Code tabs extension to display codeblocks in different languages as tabs.
sphinx-tabs==3.4.7
# Adds a 'copy' button to the right of codeblocks.
sphinx-copybutton==0.5.2
# Custom 404 error page (more useful than the default).
sphinx-notfound-page==1.1.0
# Adds Open Graph tags in the HTML `<head>` tag.
sphinxext-opengraph==0.10.0
# `.. video::` directive support to embed videos in documentation pages.
sphinxcontrib-video==0.4.1