From 5ca9254d2aced98059661c446c9a2a31a91e2cf8 Mon Sep 17 00:00:00 2001 From: Mieszko Banczerowski Date: Mon, 10 Jun 2019 18:53:02 +0200 Subject: [PATCH] GPI-438: Add link to docs in readme.md; fix make.py --- README.md | 10 +++++++--- docs/make.py | 15 +++++++++------ docs/source/overview.rst | 6 ++++++ setup.py | 2 +- 4 files changed, 23 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index fbbb420..326c283 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ -# GOG Galaxy - Community Integration - Python API +# GOG Galaxy Integrations Python API This Python library allows to easily build community integrations for various gaming platforms with GOG Galaxy 2.0. -Each integration in GOG Galaxy 2.0 comes as a separate Python script, and is launched as a separate process, that needs to communicate with main instance of GOG Galaxy 2.0. +- refer to our documentation + +## Features + +Each integration in GOG Galaxy 2.0 comes as a separate Python script, and is launched as a separate process, that which needs to communicate with main instance of GOG Galaxy 2.0. The provided features are: @@ -69,4 +73,4 @@ The additional `manifest.json` file is required: ``` ## Legal Notice -By integrating or attempting to integrate any applications or content with or into GOG Galaxy 2.0. you represent that such application or content is your original creation (other than any software made available by GOG) and/or that you have all necessary rights to grant such applicable rights to the relevant community integration to GOG and to GOG Galaxy 2.0 end users for the purpose of use of such community integration and that such community integration comply with any third party license and other requirements including compliance with applicable laws. +By integrating or attempting to integrate any applications or content with or into GOG Galaxy 2.0 you represent that such application or content is your original creation (other than any software made available by GOG) and/or that you have all necessary rights to grant such applicable rights to the relevant community integration to GOG and to GOG Galaxy 2.0 end users for the purpose of use of such community integration and that such community integration comply with any third party license and other requirements including compliance with applicable laws. diff --git a/docs/make.py b/docs/make.py index cb41897..42f6a02 100644 --- a/docs/make.py +++ b/docs/make.py @@ -1,13 +1,16 @@ """Builds documentation locally. Use for preview only""" +import pathlib import subprocess import webbrowser -source = "docs/source" -build = "docs/build" -master_doc = 'index' +source = pathlib.Path("docs", "source") +build = pathlib.Path("docs", "build") +master_doc = 'index.html' -subprocess.run(['sphinx-build', '-M', 'clean', source, build]) -subprocess.run(['sphinx-build', '-M', 'html', source, build]) -webbrowser.open(f'{build}/html/{master_doc}') \ No newline at end of file +subprocess.run(['sphinx-build', '-M', 'clean', str(source), str(build)]) +subprocess.run(['sphinx-build', '-M', 'html', str(source), str(build)]) + +master_path = build / 'html' / master_doc +webbrowser.open(f'file://{master_path.resolve()}') \ No newline at end of file diff --git a/docs/source/overview.rst b/docs/source/overview.rst index 3bd447c..cb8accb 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -1 +1,7 @@ .. mdinclude:: ../../README.md + :end-line: 4 + +.. excluding self-pointing documentation link + +.. mdinclude:: ../../README.md + :start-line: 6 diff --git a/setup.py b/setup.py index 513ede7..850b589 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ from setuptools import setup, find_packages setup( name="galaxy.plugin.api", - version="0.32.0", + version="0.32.1", description="GOG Galaxy Integrations Python API", author='Galaxy team', author_email='galaxy@gog.com',