Skip to content

Commit c543bfb

Browse files
doc/fix: make readme.rst pypi compatible
1 parent 600da3c commit c543bfb

2 files changed

Lines changed: 13 additions & 5 deletions

File tree

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
fourinsight.api
2-
###############
1+
4Insight API for Python
2+
=======================
33

4-
:py:mod:`fourinsight.api` is your portal to `4Insight.io`_ in Python, and facilitates secure calls to the `4Insight REST API`_ endpoints.
4+
``fourinsight.api`` is your portal to `4Insight.io`_ in Python, and facilitates secure calls to the `4Insight REST API`_ endpoints.
55

6-
:py:mod:`fourinsight.api` is mainly used by other high-level 4Insight Python packages. However, it can also be used to make low-level calls.
6+
``fourinsight.api`` is mainly used by other high-level 4Insight Python packages. However, it can also be used to make low-level calls.
77

88

99
.. _4Insight.io: https://4insight.io

docs/index.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
.. include:: ../README.rst
1+
4Insight API for Python
2+
=======================
3+
4+
:py:mod:`fourinsight.api` is your portal to `4Insight.io`_ in Python, and facilitates secure calls to the `4Insight REST API`_ endpoints.
5+
6+
:py:mod:`fourinsight.api` is mainly used by other high-level 4Insight Python packages. However, it can also be used to make low-level calls.
7+
8+
.. _4Insight.io: https://4insight.io
9+
.. _4Insight REST API: https://4insight.io/#/developer
210

311

412
.. toctree::

0 commit comments

Comments
 (0)