|
|
@@ -1,8 +1,8 @@
|
|
|
# Godot Engine documentation
|
|
|
|
|
|
-This repository contains the source files of [Godot Engine](http://godotengine.org)'s documentation, in reStructuredText markup language (reST).
|
|
|
+This repository contains the source files of [Godot Engine](https://godotengine.org)'s documentation, in reStructuredText markup language (reST).
|
|
|
|
|
|
-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).
|
|
|
+They are meant to be parsed with the [Sphinx](https://sphinx-doc.org/) documentation builder to build the HTML documentation on [Godot's website](https://docs.godotengine.org).
|
|
|
|
|
|
## Contributing changes
|
|
|
|
|
|
@@ -22,9 +22,9 @@ You should then add your page to the relevant "toctree" (table of contents, e.g.
|
|
|
|
|
|
### Sphinx and reStructuredText syntax
|
|
|
|
|
|
-Check Sphinx's [reST Primer](http://www.sphinx-doc.org/en/stable/rest.html) and the [official reference](http://docutils.sourceforge.net/rst.html) for details on the syntax.
|
|
|
+Check Sphinx's [reST Primer](https://www.sphinx-doc.org/en/stable/rest.html) and the [official reference](http://docutils.sourceforge.net/rst.html) for details on the syntax.
|
|
|
|
|
|
-Sphinx uses specific reST comments to do specific operations, like defining the table of contents (`:toctree:`) or cross-referencing pages. Check the [official Sphinx documentation](http://www.sphinx-doc.org/en/stable/index.html) for more details, or see how things are done in existing pages and adapt it to your needs.
|
|
|
+Sphinx uses specific reST comments to do specific operations, like defining the table of contents (`:toctree:`) or cross-referencing pages. Check the [official Sphinx documentation](https://www.sphinx-doc.org/en/stable/index.html) for more details, or see how things are done in existing pages and adapt it to your needs.
|
|
|
|
|
|
### Adding images and attachments
|
|
|
|
|
|
@@ -40,7 +40,7 @@ Similarly, you can include attachments (like assets as support material for a tu
|
|
|
|
|
|
## 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 flavor was tested, though the Python 2 versions might work too.
|
|
|
+To build the HTML website (or any other format supported by Sphinx, like PDF, EPUB or LaTeX), you need to install [Sphinx](https://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 flavor 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:
|
|
|
|
Rémi Verschelde