godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Use HTTPS for links which support it

Browse Source
This commit is contained in:
Rémi Verschelde
2018-12-13 12:06:02 +01:00
parent 8a49da6da5
commit a95cd08285
4 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -1,8 +1,8 @@
# Godot Engine documentation # 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 ## 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 ### 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 ### Adding images and attachments
@@ -40,7 +40,7 @@ Similarly, you can include attachments (like assets as support material for a tu
## Building with Sphinx ## 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: 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:

20
_templates/layout.html
View File

@@ -1,14 +1,14 @@
{% extends "!layout.html" %} {% extends "!layout.html" %}
{% block linktags %} {% block linktags %}
<link rel="alternate" hreflang="en" href="http://docs.godotengine.org/en/" /> <link rel="alternate" hreflang="en" href="https://docs.godotengine.org/en/" />
<link rel="alternate" hreflang="de" href="http://docs.godotengine.org/de/" /> <link rel="alternate" hreflang="de" href="https://docs.godotengine.org/de/" />
<link rel="alternate" hreflang="es" href="http://docs.godotengine.org/es/" /> <link rel="alternate" hreflang="es" href="https://docs.godotengine.org/es/" />
<link rel="alternate" hreflang="fr" href="http://docs.godotengine.org/fr/" /> <link rel="alternate" hreflang="fr" href="https://docs.godotengine.org/fr/" />
<link rel="alternate" hreflang="ko" href="http://docs.godotengine.org/ko/" /> <link rel="alternate" hreflang="ko" href="https://docs.godotengine.org/ko/" />
<link rel="alternate" hreflang="pl" href="http://docs.godotengine.org/pl/" /> <link rel="alternate" hreflang="pl" href="https://docs.godotengine.org/pl/" />
<link rel="alternate" hreflang="pt-br" href="http://docs.godotengine.org/pt-br/" /> <link rel="alternate" hreflang="pt-br" href="https://docs.godotengine.org/pt-br/" />
<link rel="alternate" hreflang="uk" href="http://docs.godotengine.org/uk/" /> <link rel="alternate" hreflang="uk" href="https://docs.godotengine.org/uk/" />
<link rel="alternate" hreflang="zh-cn" href="http://docs.godotengine.org/zh-cn/" /> <link rel="alternate" hreflang="zh-cn" href="https://docs.godotengine.org/zh-cn/" />
<link rel="alternate" hreflang="x-default" href="http://docs.godotengine.org/" /> <link rel="alternate" hreflang="x-default" href="https://docs.godotengine.org/" />
{{ super() }} {{ super() }}
{% endblock %} {% endblock %}

2
community/contributing/documentation_guidelines.rst
View File

@@ -7,7 +7,7 @@ This page describes the rules to follow if you want to contribute to Godot
Engine by writing or reviewing documentation, or by translating existing Engine by writing or reviewing documentation, or by translating existing
documentation. Also have a look at README of the documentation. Also have a look at README of the
`godot-docs GitHub repository <https://github.com/godotengine/godot-docs>`_ `godot-docs GitHub repository <https://github.com/godotengine/godot-docs>`_
and the `docs front page <http://docs.godotengine.org>`_ and the `docs front page <https://docs.godotengine.org>`_
on what steps to follow and how to contact the docs team. on what steps to follow and how to contact the docs team.
How to contribute How to contribute

2
index.rst
View File

@@ -8,7 +8,7 @@ Godot Docs – *master* branch
.. attention:: This is the documentation for the unstable (master) branch. .. attention:: This is the documentation for the unstable (master) branch.
Looking for the documentation of the current **stable** branch? Looking for the documentation of the current **stable** branch?
`Have a look here <http://docs.godotengine.org/en/stable>`_. `Have a look here <https://docs.godotengine.org/en/stable>`_.
Welcome to the official documentation of Godot Engine, the free and open source Welcome to the official documentation of Godot Engine, the free and open source
community-driven 2D and 3D game engine! If you are new to this documentation, community-driven 2D and 3D game engine! If you are new to this documentation,