Skip to content
This repository was archived by the owner on Jan 13, 2023. It is now read-only.

Add header to readme with link to documentation portal #282

Merged
merged 4 commits into from
Dec 16, 2019

Conversation

JakeSCahill
Copy link
Contributor

Added a consistent header that will be used across all our client libraries. This header has a clear link to the official docs.

Copy link
Collaborator

@lzpap lzpap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep README.rst as it is needed for RTD build. Move it under docs.

README.rst Outdated
@@ -1,121 +0,0 @@
.. image:: https://travis-ci.org/iotaledger/iota.py.svg?branch=master
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README.rst is needed to build the documentation for ReadTheDocs.
We could move this file under docs folder, and modify docs/index.rst to contain

.. include:: README.rst

@todofixthis todofixthis changed the base branch from master to develop December 13, 2019 22:46
Copy link
Collaborator

@lzpap lzpap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more thing to make the build pass: add docs/ to the filename in setup.py like this:

# Load long description for PyPI.
with open('docs/README.rst', 'r', 'utf-8') as f:  # type: StreamReader
    long_description = f.read()

@lzpap lzpap merged commit 2f9d1b0 into iotaledger-archive:develop Dec 16, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants