include Platform id's in sphinx generated documentation + some fixed

This commit is contained in:
Pawel Czoppa
2019-06-15 14:57:20 +02:00
parent be3d3bb7e5
commit b28fc60088
3 changed files with 13 additions and 2 deletions

View File

@@ -64,7 +64,8 @@ if __name__ == "__main__":
The client has a built-in Python 3.7 interpreter, so the integrations are delivered as python modules.
In order to be found by GOG Galaxy 2.0 an integration folder should be placed in [lookup directory](#deploy-location). Beside all the python files, the integration folder has to contain [manifest.json](#deploy-manifest) and all third-party dependencies. See an [examplary structure](#deploy-structure-example).
### <a name="deploy-location"></a> Lookup directory:
### Lookup directory
<a name="deploy-location"></a>
- Windows:
`%localappdata%\GOG.com\Galaxy\plugins\installed`
@@ -73,7 +74,8 @@ In order to be found by GOG Galaxy 2.0 an integration folder should be placed in
`~/Library/Application Support/GOG.com/Galaxy/plugins/installed`
### <a name="deploy-manifest"></a> Manifest
### Manifest
<a name="deploy-manifest"></a>
Obligatory JSON file to be placed in a integration folder.
```json

View File

@@ -7,6 +7,7 @@ GOG Galaxy Integrations Python API
Overview <overview>
API <galaxy.api>
Platform ID's <platforms>
Index
-------------------

View File

@@ -5,3 +5,11 @@
.. mdinclude:: ../../README.md
:start-line: 6
:end-line: 26
.. excluding Platforms Id's link
:ref:`platforms-link`.
.. mdinclude:: ../../README.md
:start-line: 28