diff --git a/README.md b/README.md index cae0104..37f662e 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,29 @@ # Godot Engine Contributing documentation -WIP Repository +This repository contains the source files of [Godot Engine](https://godotengine.org)'s contributing documentation, in reStructuredText markup language (reST). -## Setup +They are meant to be parsed with the [Sphinx](https://www.sphinx-doc.org/) documentation builder to build the corresponding HTML documentation on [Godot's website](https://contributing.godotengine.org). -```bash -python -m venv .venv -source .venv/bin/activate -pip install -r requirements.txt -``` +## Theming -## Serve +The Godot contributing documentation uses the default `sphinx_rtd_theme` with many +[customizations](_static/) applied on top. It will automatically switch between +the light and dark theme depending on your browser/OS' theming preference. -```bash -source .venv/bin/activate -make html -cd build/html -python -m http.server -``` +If you use Firefox and wish to use the dark theme regardless of your OS +configuration, you can install the +[Dark Website Forcer](https://addons.mozilla.org/en-US/firefox/addon/dark-mode-website-switcher/) +add-on. + +## Contributing + +All contributors are welcome to help on the Godot contributing documentation. + +To get started, head to the [explainer article](https://contributing.godotengine.org/en/latest/documentation/contributing_to_the_contributing_docs.html). + +## License + +With the exception of the `classes/` folder, all the content of this repository is licensed under the Creative Commons Attribution 3.0 Unported license ([CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)) and is to be attributed to "Juan Linietsky, Ariel Manzur and the Godot community". +See [LICENSE.txt](/LICENSE.txt) for details. + +The files in the `classes/` folder are derived from [Godot's main source repository](https://github.com/godotengine/godot) and are distributed under the MIT license, with the same authors as above. diff --git a/documentation/contributing_to_the_contributing_docs.rst b/documentation/contributing_to_the_contributing_docs.rst index 0ab761a..1f13491 100644 --- a/documentation/contributing_to_the_contributing_docs.rst +++ b/documentation/contributing_to_the_contributing_docs.rst @@ -63,3 +63,25 @@ in which you can contribute to Godot. To accomplish this, every *kind* of contribution should have a dedicated section in the side bar. If a new way to contribute emerges, it should get a dedicated section in the side bar so that it is easy to find. + +Building the documentation locally +---------------------------------- + +You may want to test your changes locally before making a pull request. +To do this, you first need to install `Python `__, if it is not already installed. +We recommend you use a virtual environment to install the required packages: + +.. code-block:: shell + + python -m venv .venv + source .venv/bin/activate + pip install -r requirements.txt + +You can build and serve the documentation by running the following commands: + +.. code-block:: shell + + source .venv/bin/activate + make html + cd build/html + python -m http.server