diff --git a/_static/css/custom.css b/_static/css/custom.css index 473b46f48..f403badba 100644 --- a/_static/css/custom.css +++ b/_static/css/custom.css @@ -918,12 +918,14 @@ code, /* Admonition tweaks */ +.rst-content .admonition, .rst-content .admonition.note, .rst-content .admonition.seealso { background-color: var(--admonition-note-background-color); color: var(--admonition-note-color); } +.rst-content .admonition .admonition-title, .rst-content .admonition.note .admonition-title, .rst-content .admonition.seealso .admonition-title { background-color: var(--admonition-note-title-background-color); @@ -1587,3 +1589,11 @@ p + .classref-constant { .wy-menu-vertical p.caption + ul.active { display: block; } + +/* Top navigation, breadcrumbs */ +.wy-breadcrumbs li a { + padding: 0 5px; +} +.wy-breadcrumbs li a:first-child { + padding-left: 0; +} diff --git a/_templates/breadcrumbs.html b/_templates/breadcrumbs.html index 0a60a7a1f..6b321e523 100644 --- a/_templates/breadcrumbs.html +++ b/_templates/breadcrumbs.html @@ -9,6 +9,7 @@ font-size: 14px; float: right; clear: both; + padding-top: 4px; } @media screen and (max-width: 480px) { diff --git a/index.rst b/index.rst index 620bf84a6..cf6cc0606 100644 --- a/index.rst +++ b/index.rst @@ -10,7 +10,7 @@ Godot Docs – *master* branch .. only:: i18n .. note:: This documentation is translated from the `original English one - `_ by community members + `_ by community members on `Weblate `_. Depending on the translation effort's completion level, you may @@ -19,8 +19,9 @@ Godot Docs – *master* branch ones on Weblate. For the time being, localized translations are only available for - the "latest" (development) branch, but should be suitable to learn - how to use stable Godot releases nevertheless. + the "stable" branch. You can still view the English documentation for + other engine versions using the "Read the Docs" panel at the bottom + of the sidebar. Welcome to the official documentation of `Godot Engine `__, the free and open source community-driven 2D and 3D game engine! If you are new @@ -28,9 +29,27 @@ to this documentation, we recommend that you read the :ref:`introduction page ` to get an overview of what this documentation has to offer. -The table of contents below and in the sidebar should let you easily access the -documentation for your topic of interest. You can also use the search function -in the top-left corner. +The table of contents in the sidebar should let you easily access the documentation +for your topic of interest. You can also use the search function in the top-left corner. + +Get involved +------------ + +Godot Engine is an open source project developed by a community of volunteers. +The documentation team can always use your feedback and help to improve the +tutorials and class reference. If you don't understand something, or cannot find +what you are looking for in the docs, help us make the documentation better +by letting us know! + +Submit an issue or pull request on the `GitHub repository `_, +help us `translate the documentation `_ +into your language, or talk to us on the ``#documentation`` channel on the +`Godot Contributors Chat `_! + +.. centered:: |weblate_widget| + +Offline documentation +--------------------- To browse the documentation offline, you can use the mirror of the documentation hosted on `DevDocs `__. To enable offline browsing on @@ -46,26 +65,12 @@ You can also `download an HTML copy `_, - help us `translate the documentation - `_ into your - language, or talk to us on the - ``#documentation`` channel on the `Godot Contributors Chat - `_! - -.. centered:: |weblate_widget| - -The main documentation for the site is organized into the following sections: +.. Below is the main table-of-content tree of the documentation website. + It is hidden on the page itself, but it makes up the sidebar for navigation. .. toctree:: + :hidden: :maxdepth: 1 :caption: About :name: sec-general @@ -79,6 +84,7 @@ The main documentation for the site is organized into the following sections: about/complying_with_licenses .. toctree:: + :hidden: :maxdepth: 1 :caption: Getting started :name: sec-learn @@ -91,6 +97,7 @@ The main documentation for the site is organized into the following sections: .. The sections below are sorted alphabetically. Please keep them that way. .. toctree:: + :hidden: :maxdepth: 1 :caption: Tutorials :name: sec-tutorials @@ -121,6 +128,7 @@ The main documentation for the site is organized into the following sections: .. toctree:: + :hidden: :maxdepth: 1 :caption: Engine Development :name: sec-devel @@ -132,6 +140,7 @@ The main documentation for the site is organized into the following sections: .. toctree:: + :hidden: :maxdepth: 1 :caption: Community :name: sec-community @@ -143,16 +152,9 @@ The main documentation for the site is organized into the following sections: .. toctree:: + :hidden: :maxdepth: 1 :caption: Class reference :name: sec-class-ref classes/index - - -.. Indices and tables -.. ------------------ -.. -.. * :ref:`genindex` -.. * :ref:`modindex` -.. * :ref:`search`