Skip to content

Commit 26f5e16

Browse files
committed
Update readme, and move build instructions to the "Contributing to the contributing docs" article.
1 parent c0099ae commit 26f5e16

File tree

2 files changed

+45
-14
lines changed

2 files changed

+45
-14
lines changed

README.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,29 @@
11
# Godot Engine Contributing documentation
22

3-
WIP Repository
3+
This repository contains the source files of [Godot Engine](https://godotengine.org)'s contributing documentation, in reStructuredText markup language (reST).
44

5-
## Setup
5+
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).
66

7-
```bash
8-
python -m venv .venv
9-
source .venv/bin/activate
10-
pip install -r requirements.txt
11-
```
7+
## Theming
128

13-
## Serve
9+
The Godot contributing documentation uses the default `sphinx_rtd_theme` with many
10+
[customizations](_static/) applied on top. It will automatically switch between
11+
the light and dark theme depending on your browser/OS' theming preference.
1412

15-
```bash
16-
source .venv/bin/activate
17-
make html
18-
cd build/html
19-
python -m http.server
20-
```
13+
If you use Firefox and wish to use the dark theme regardless of your OS
14+
configuration, you can install the
15+
[Dark Website Forcer](https://addons.mozilla.org/en-US/firefox/addon/dark-mode-website-switcher/)
16+
add-on.
17+
18+
## Contributing
19+
20+
All contributors are welcome to help on the Godot contributing documentation.
21+
22+
To get started, head to the [explainer article](https://contributing.godotengine.org/en/latest/documentation/contributing_to_the_contributing_docs.html).
23+
24+
## License
25+
26+
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".
27+
See [LICENSE.txt](/LICENSE.txt) for details.
28+
29+
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.

documentation/contributing_to_the_contributing_docs.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,25 @@ in which you can contribute to Godot. To accomplish this, every *kind*
6363
of contribution should have a dedicated section in the side bar. If a new
6464
way to contribute emerges, it should get a dedicated section in the side
6565
bar so that it is easy to find.
66+
67+
Building the documentation locally
68+
----------------------------------
69+
70+
You may want to test your changes locally before making a pull request.
71+
To do this, you first need to install `Python <https://www.python.org>`__, if it is not already installed.
72+
We recommend you use a virtual environment to install the required packages:
73+
74+
.. code-block:: shell
75+
76+
python -m venv .venv
77+
source .venv/bin/activate
78+
pip install -r requirements.txt
79+
80+
You can build and serve the documentation by running the following commands:
81+
82+
.. code-block:: shell
83+
84+
source .venv/bin/activate
85+
make html
86+
cd build/html
87+
python -m http.server

0 commit comments

Comments
 (0)