diff --git a/README.rst b/README.rst index fad9a61..dcd3e09 100755 --- a/README.rst +++ b/README.rst @@ -25,19 +25,19 @@ Features Screenshots ----------- -.. figure:: docs/static/ui_overview.png +.. figure:: https://raw.githubusercontent.com/rheinwerk-verlag/planning-poker/main/docs/static/ui_overview.png :width: 100% :alt: You can see all the necessary information on a single page You can see all the necessary information on a single page -.. figure:: docs/static/participants_overview.gif +.. figure:: https://raw.githubusercontent.com/rheinwerk-verlag/planning-poker/main/docs/static/participants_overview.gif :width: 100% :alt: Live updated list of participants Live updated list of participants -.. figure:: docs/static/dark_mode.png +.. figure:: https://raw.githubusercontent.com/rheinwerk-verlag/planning-poker/main/docs/static/dark_mode.png :width: 100% :alt: Natively supported dark mode diff --git a/docs/conf.py b/docs/conf.py index 2fbe5f3..0f79a4e 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -306,18 +306,20 @@ class RepoImagePathTransform(SphinxTransform): - """Remove the leading 'docs/' directory where possible from all image URIs. - The relative paths of the images in the 'README.rst' all start with the 'docs' directory in order to show them - on the repository overview page. Since the same readme file should also be used inside the docs, the directory has - to be removed from the paths when building the docs. + """Remove the leading GitHub repo prefix where possible from all image URIs. + The URIs of the images in the 'README.rst' all start with the prefix of the GitHub repo in order to show them on the + repository overview page and on PyPI. Since the same readme file should also be used inside the docs, the prefix + has to be removed from the paths when building the docs. """ default_priority = 409 + github_repo_prefix = 'https://raw.githubusercontent.com/rheinwerk-verlag/planning-poker/main/docs/' def apply(self, **kwargs): + github_repo_prefix_length = len(self.github_repo_prefix) for node in self.document.traverse(nodes.image): uri = node.attributes['uri'] - if uri.startswith('docs/'): - node.attributes['uri'] = uri[5:] + if uri.startswith(self.github_repo_prefix): + node.attributes['uri'] = uri[github_repo_prefix_length:] def setup(app): diff --git a/planning_poker/version.py b/planning_poker/version.py index 1c297bd..21abbf6 100755 --- a/planning_poker/version.py +++ b/planning_poker/version.py @@ -1 +1 @@ -__version__ = '0.3.1' # pragma: no cover +__version__ = '1.0.0' # pragma: no cover diff --git a/setup.py b/setup.py index 438e111..da797aa 100755 --- a/setup.py +++ b/setup.py @@ -12,8 +12,8 @@ from wheel.bdist_wheel import bdist_wheel -def read(*args): - return open(join(dirname(__file__), *args)).read() +def read(*args, **kwargs): + return open(join(dirname(__file__), *args), **kwargs).read() class ToxTestCommand(distutils.cmd.Command): @@ -105,7 +105,7 @@ def command_factory(name, base_class): name='planning-poker', version=__version__, # noqa description='A Django app which allows teams to perform a remote planning poker session', - long_description=read('README.rst'), + long_description=read('README.rst', encoding='utf-8'), author='Rheinwerk Webteam', author_email='webteam@rheinwerk-verlag.de', maintainer='Rheinwerk Verlag GmbH Webteam',