From b28fc60088f3606587cc29ea317464f88526a331 Mon Sep 17 00:00:00 2001 From: Pawel Czoppa Date: Sat, 15 Jun 2019 14:57:20 +0200 Subject: [PATCH] include Platform id's in sphinx generated documentation + some fixed --- README.md | 6 ++++-- docs/source/index.rst | 1 + docs/source/overview.rst | 8 ++++++++ 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7ef7d1a..4330b1f 100644 --- a/README.md +++ b/README.md @@ -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). -### Lookup directory: +### Lookup directory + - 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` -### Manifest +### Manifest + Obligatory JSON file to be placed in a integration folder. ```json diff --git a/docs/source/index.rst b/docs/source/index.rst index 05f97f7..4455599 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,6 +7,7 @@ GOG Galaxy Integrations Python API Overview API + Platform ID's Index ------------------- diff --git a/docs/source/overview.rst b/docs/source/overview.rst index cb8accb..ea506a8 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -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