|
@@ -4,38 +4,13 @@ This repository contains the source files of [Godot Engine](http://godotengine.o
|
|
|
|
|
|
They are meant to be parsed with the [Sphinx](http://sphinx-doc.org/) documentation builder to build the HTML documentation on [Godot's website](http://docs.godotengine.org).
|
|
|
|
|
|
-## License
|
|
|
-
|
|
|
-At 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".
|
|
|
-
|
|
|
-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.
|
|
|
-
|
|
|
-## Building with Sphinx
|
|
|
-
|
|
|
-To build the HTML website (or any other format supported by Sphinx, like PDF, EPUB or LaTeX), you need to install [Sphinx](http://sphinx-doc.org/) >= 1.3 as well as (for the HTML) the [readthedocs.org theme](https://github.com/snide/sphinx_rtd_theme). Only the Python 3 flavour was tested, though the Python 2 versions might work too.
|
|
|
-
|
|
|
-Those tools are best installed using [pip](https://pip.pypa.io), Python's module installer. The Python 3 version might be provided (on Linux distros) as `pip3` or `python3-pip`. You can then run:
|
|
|
-
|
|
|
-```sh
|
|
|
-pip3 install sphinx
|
|
|
-pip3 install sphinx_rtd_theme
|
|
|
-```
|
|
|
-
|
|
|
-You can then build the HTML documentation from the root folder of this repository with:
|
|
|
-```sh
|
|
|
-make html
|
|
|
-```
|
|
|
-
|
|
|
-The compilation might take some time as the `classes/` folder contains many files to parse.
|
|
|
-You can then test the changes live by opening `_build/html/index.html` in your favourite browser.
|
|
|
-
|
|
|
## Contributing changes
|
|
|
|
|
|
Though arguably less convenient to edit than a wiki, this git repository is meant to receive pull requests to always improve the documentation, add new pages, etc. Having direct access to the source files in a revision control system is a big plus to ensure the quality of our documentation.
|
|
|
|
|
|
### Editing existing pages
|
|
|
|
|
|
-To edit an existing page, just locate its .rst source file and open it in your favourite text editor. You can then commit the changes, push them to your fork and make a pull request. Note that the pages in `classes/` are automatically generated from Godot's XML class reference, so they should not be edited here.
|
|
|
+To edit an existing page, just locate its .rst source file and open it in your favourite text editor. You can then commit the changes, push them to your fork and make a pull request. **Note that the pages in `classes/`should not be edited here, they are automatically generated from Godot's [XML class reference](https://github.com/godotengine/godot/tree/master/doc/base).**
|
|
|
|
|
|
### Adding new pages
|
|
|
|
|
@@ -60,3 +35,28 @@ Similarly, you can include attachments (like assets as support material for a tu
|
|
|
```rst
|
|
|
:download:`myfilename.zip </files/myfilename.zip>`
|
|
|
```
|
|
|
+
|
|
|
+## Building with Sphinx
|
|
|
+
|
|
|
+To build the HTML website (or any other format supported by Sphinx, like PDF, EPUB or LaTeX), you need to install [Sphinx](http://sphinx-doc.org/) >= 1.3 as well as (for the HTML) the [readthedocs.org theme](https://github.com/snide/sphinx_rtd_theme). Only the Python 3 flavour was tested, though the Python 2 versions might work too.
|
|
|
+
|
|
|
+Those tools are best installed using [pip](https://pip.pypa.io), Python's module installer. The Python 3 version might be provided (on Linux distros) as `pip3` or `python3-pip`. You can then run:
|
|
|
+
|
|
|
+```sh
|
|
|
+pip3 install sphinx
|
|
|
+pip3 install sphinx_rtd_theme
|
|
|
+```
|
|
|
+
|
|
|
+You can then build the HTML documentation from the root folder of this repository with:
|
|
|
+```sh
|
|
|
+make html
|
|
|
+```
|
|
|
+
|
|
|
+The compilation might take some time as the `classes/` folder contains many files to parse.
|
|
|
+You can then test the changes live by opening `_build/html/index.html` in your favourite browser.
|
|
|
+
|
|
|
+## License
|
|
|
+
|
|
|
+At 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".
|
|
|
+
|
|
|
+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.
|