GPI-438: Add link to docs in readme.md; fix make.py

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 <a href='https://galaxy-integrations-python-api.readthedocs.io'>documentation</a>
+
+## 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.

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}')
+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()}')

docs/source/overview.rst

@@ -1 +1,7 @@
 .. mdinclude:: ../../README.md
+   :end-line: 4
+
+.. excluding self-pointing documentation link
+
+.. mdinclude:: ../../README.md
+   :start-line: 6

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',