3114 Commits

Author SHA1 Message Date
Rémi Verschelde
0e82d3e273 Further cleanup intro text which is outdated 2023-02-15 17:30:21 +01:00
Rémi Verschelde
22d7ee90e1 Add caution message that this is outdated documentation 2023-02-15 15:50:36 +01:00
Hugo Locurcio
05f7a1e5cd Increase spacing between list items to improve readability (#5962) 2022-07-23 02:30:02 +02:00
Rémi Verschelde
35ad0f08bf Merge pull request #5934 from YuriSizov/3.1-is-out-of-beta 2022-07-14 16:04:45 +02:00
Yuri Sizov
6f96448b6e Update 3.1 custom.js to match the rest of stable branches 2022-07-14 16:51:16 +03:00
Max Hilbrunner
2011a8a064 Merge pull request #5089 from pycbouh/frontend-fix-nested-kbd
Fix styling for keyboard shortcuts

(cherry picked from commit 5b26374cb0)
2021-07-15 18:06:23 +02:00
Rémi Verschelde
122f3c7b62 Update .readthedocs.yml config to disable PDF and EPUB builds 2021-05-06 16:48:20 +02:00
Rémi Verschelde
88a376822e Add requirements.txt for old sphinx version used here
Our ReadTheDocs project config now specifies the use of a requirements.txt file
so builds for old branches started failing without it.
2021-05-03 21:38:32 +02:00
Hugo Locurcio
f3607cb52a Fix height() functions missing return in Your second Spatial shader 2021-04-10 19:24:59 +02:00
Rémi Verschelde
e1d18ee784 Remove controversial satirical piece 🔥
This piece was written back in 2014 before open sourcing Godot, and while its
intent is to be sarcastic, it leaves ample room for misinterpretation.

The intended meaning of this piece was, and always has been, the following:

Exploitative game mechanics suck. Games are a beautiful and artful medium
which can provide players with a wide range of experiences: entertainment,
enlightenment, joy, sadness... Games can be just for fun or they can bear
a message. They can connect people with each other or open the player's mind.

Make games worth your players' time and their money, and do your best to do so
while running a successful and respectful business. Hugs <3

(cherry picked from commit b872229427)
2021-03-04 11:17:38 +01:00
Hugo Locurcio
1dc8be1933 Add .editorconfig and .gitattributes files for automatic settings
This smoothens the contribtor experience by automatically configuring
editors that support EditorConfig.

The `.gitattributes` file ensures that all files use LF line endings
when committed to Git.
2021-03-01 17:54:05 +01:00
Hugo Locurcio
ad8d17c364 Add a more descriptive custom 404 error page (#4624)
This helps users find their way back to the documentation.
2021-02-06 16:21:58 +01:00
Rémi Verschelde
08fc7daec3 Merge pull request #4579 from Calinou/backport-theme-changes-3.1
Backport theming changes from `master` to `3.1`
2021-01-29 01:08:52 +01:00
Hugo Locurcio
a36a624750 Backport theming changes from master to 3.1 2021-01-25 16:36:25 +01:00
Max Hilbrunner
496c7bf0e7 Create Sphinx extension to generate HTML meta description tags
(cherry picked from commit 2927a912a5)
2020-05-04 09:35:02 +02:00
Max Hilbrunner
ad2e2c9ec0 Prepend "(DEV)" to HTML titles if build locally/not on RTD
(cherry picked from commit 0b6d26e33d)
2020-05-04 09:35:02 +02:00
Max Hilbrunner
2668f8b5a9 Appease our great search engine overlords
This hopefully fixes all translated pages showing up in search engine results, and makes the STABLE version of each page canonical.
In turn, this allows us to re-enable indexing of the version-specific pages (see robots.txt changes), as search engines should prefer the canonical (stable) version, and only show the other versions if no canonical (stable) version exists (i.e. because that feature is only in latest, or was removed in stable).

It adds proper canonical links for all generated pages, and fixes the existing links between the various translations of a page by both ensuring the pages links to itself with the proper language tag, and by properly linking to the full path of other translated versions.

(cherry picked from commits:
- fd5f6f4909,
- 263ff56251,
- e21df0671f,
- 24781e377b,
- 66d185d5d2,
- 3c79f3e321)

Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2020-05-04 09:35:02 +02:00
Rémi Verschelde
ce8cf81556 conf.py: Format with black and rename extensions to _extensions
To match changes in master branch and ease cherrypicks.
2020-05-04 09:19:58 +02:00
Rémi Verschelde
8513fbcdea conf.py: Get version from RTD when available
(cherry picked from commit 605222c094)
2020-03-31 10:06:11 +02:00
Rémi Verschelde
976a6d354a Add robots.txt file to prevent indexing outdated docs
Cherry-picked from 2e37935e73b629fd9ecaabf958943cabc3ac825 and follow-ups.
2020-03-16 12:21:55 +01:00
Rémi Verschelde
3e8e67ac95 Sync classref with current source 2020-01-21 09:28:25 +01:00
Hugo Locurcio
e11844538c Merge pull request #2977 from timkrief/patch-1
Update screen-reading_shaders.rst
2019-12-11 20:13:02 +01:00
Tim Krief
d2bdbb464f Update screen-reading_shaders.rst
Removed an unnecessary "}"
2019-12-11 09:53:17 +01:00
Rémi Verschelde
5c120ff17a Merge pull request #2944 from hiulit/patch-1
Added missing references for some functions
2019-11-22 14:38:21 +01:00
Xavier Gómez Gosálbez
44b38d79e1 Added missing references for some functions
I've added some missing references for some functions to better interact with the docs.
2019-11-22 13:52:21 +01:00
Zak Stam
569628e17e Mono build: use release_debug target for debug templates (#2937)
See godotengine/godot#33699.
2019-11-18 13:07:30 +01:00
Rémi Verschelde
0d0baba55c X11: Readd freetype as build dep for 3.1 branch
It's no longer needed for 3.1.2+, but users may still need it for 3.1
or 3.1.1 custom builds if they don't use `builtin_freetype=yes` for
portability.

Partial revert of commit fc7ea4669b.

Fixes #2679.
2019-08-06 08:13:42 +02:00
Rémi Verschelde
a20f5e758e Sync classref with current source 2019-07-29 21:15:14 +02:00
Rémi Verschelde
d1038285ab Revert "Organized and updated spatial shader docs"
This reverts commit 12010e1449.
Contains 3.2-specific changes.
2019-07-29 18:36:03 +02:00
Rémi Verschelde
98e0adf5d8 Merge branch 'master' into 3.1 2019-07-29 18:20:01 +02:00
Rémi Verschelde
c19078ee16 Merge pull request #2661 from akien-mga/gdnative-proofreading
Improve GDNative C Example tutorial + wrap to 80 chars
2019-07-29 13:53:26 +02:00
Rémi Verschelde
42eb493111 Merge pull request #2634 from Calinou/update-introduction-buildsystem
Improve "Introduction to the buildsystem" with updated SCons commands
2019-07-29 10:37:33 +02:00
Rémi Verschelde
bdc1ada8b1 Merge pull request #2666 from Calinou/fix-sphinx-weblate-widget-warning
Fix Sphinx Weblate widget warning
2019-07-29 10:36:47 +02:00
Rémi Verschelde
e038df8e51 Merge pull request #2665 from Calinou/fix-sphinx-codeblock-warnings
Fix Sphinx build warnings related to code blocks
2019-07-29 10:35:05 +02:00
Rémi Verschelde
a52c42f290 Improve GDNative C Example tutorial
Improve language somewhat, and more details where relevant (e.g.
regarding the version of godot_headers).

Add a section on using the GDNativeLibrary editor plugin.
2019-07-29 10:33:31 +02:00
Hugo Locurcio
589282d90b Fix Sphinx Weblate widget warning
The `weblate_widget` substitution is now always defined.
This also makes it possible to remove some duplication in `index.rst`.
2019-07-28 05:24:56 +02:00
Hugo Locurcio
f5399577a8 Fix Sphinx build warnings related to code blocks 2019-07-28 04:17:36 +02:00
Hugo Locurcio
9c4371be56 Improve "Introduction to the buildsystem" with updated SCons commands
This also documents how to create a `version.txt` file when creating custom
export template packs.

This closes #2481.
2019-07-26 23:22:57 +02:00
Rémi Verschelde
4b0bbf18ac Merge pull request #2659 from skyace65/AudioStreamUpdate
Update audio stream images for Godot 3.1
2019-07-26 18:40:49 +02:00
Rémi Verschelde
def522830a Merge pull request #2658 from skyace65/SplashScreenUpdate
Update splash screen tutorial for Godot 3.1
2019-07-26 18:40:36 +02:00
Rémi Verschelde
1afdb36a65 Wrap GDNative tutorials to 80 chars 2019-07-26 14:21:31 +02:00
Rémi Verschelde
6b2dee0c47 Fix rst formatting issues that confuse pandoc 2019-07-26 13:24:50 +02:00
skyace65
aacdf37349 Update audio stream images for Godot 3.1 2019-07-25 22:38:21 -04:00
skyace65
4474101786 Update splash screen tutorial for Godot 3.1 2019-07-25 21:41:34 -04:00
Rémi Verschelde
a6136c6651 Sync classref with current source, adds :github_url: hide meta 2019-07-25 16:47:28 +02:00
Rémi Verschelde
a02be281a8 Merge pull request #2656 from StraToN/rm-gh-link-classes
Adds a breadcrumb template to manage hiding 'Edit on Github' link.
2019-07-25 16:08:04 +02:00
StraToN
54c3b3e98a Adds a breadcrumb template to manage hiding 'Edit on Github' link.
To work, requires adding a meta the very beginning of files that have to hide this link:
:github_url: hide
2019-07-25 15:49:11 +02:00
Rémi Verschelde
fd7992cd9c Merge pull request #2648 from skyace65/MainMenuFix
Fix Main Menu tutorial issue
2019-07-25 10:17:18 +02:00
Rémi Verschelde
e3234d4415 Merge pull request #2646 from Calinou/improve-compiling-with-mono
Improve writing style in "Compiling with Mono"
2019-07-25 10:16:18 +02:00
Rémi Verschelde
32d21eaf4b Merge pull request #2631 from vortexofdoom/spatial-shader
Organized and updated spatial shader docs
2019-07-23 08:16:49 +02:00