update readthedocs

docs/source/index.rst

@@ -0,0 +1,116 @@
+:notoc:
+
+.. pyufunc documentation master file, created by Xiangyong Luo
+
+.. module:: pyufunc
+
+*********************
+pyufunc documentation
+*********************
+
+**Date**: |today| **Version**: |version|
+
+**Previous versions**: Documentation of previous pandas versions is available at
+`pyufunc <https://github.com/xyluo25/pyufunc/>`__.
+
+**Useful links**:
+`Binary Installers <https://pypi.org/project/pyufunc>`__ |
+`Source Repository <https://github.com/xyluo25/pyufunc>`__ |
+`Issues & Ideas <https://github.com/xyluo25/pyufunc/issues>`__ |
+
+:mod:`pyufunc` is an open source, MIT-licensed library providing high-performance,
+easy-to-use utility function tools for the `Python <https://www.python.org/>`__
+programming language.
+
+.. grid:: 1 2 2 2
+    :gutter: 4
+    :padding: 2 2 0 0
+    :class-container: sd-text-center
+
+    .. grid-item-card:: Getting started
+        :img-top: _static/index_getting_started.svg
+        :class-card: intro-card
+        :shadow: md
+
+        New to *pyufunc*? Check out the getting started guides. They contain an
+        introduction to *pyufunc'* main concepts and links to additional tutorials.
+
+        +++
+
+        .. button-ref:: getting_started
+            :ref-type: ref
+            :click-parent:
+            :color: secondary
+            :expand:
+
+            To getting started guides
+
+    .. grid-item-card::  User guide
+        :img-top: _static/index_user_guide.svg
+        :class-card: intro-card
+        :shadow: md
+
+        The user guide provides in-depth information on the
+        key concepts of pyufunc with useful background information and explanation.
+
+        +++
+
+        .. button-ref:: user_guide
+            :ref-type: ref
+            :click-parent:
+            :color: secondary
+            :expand:
+
+            To the user guide
+
+    .. grid-item-card::  API reference
+        :img-top: _static/index_api.svg
+        :class-card: intro-card
+        :shadow: md
+
+        The reference guide contains a detailed description of
+        the pyufunc API. The reference describes how the methods work and which parameters can
+        be used. It assumes that you have an understanding of the key concepts.
+
+        +++
+
+        .. button-ref:: api
+            :ref-type: ref
+            :click-parent:
+            :color: secondary
+            :expand:
+
+            To the reference guide
+
+    .. grid-item-card::  Developer guide
+        :img-top: _static/index_contribute.svg
+        :class-card: intro-card
+        :shadow: md
+
+        Saw a typo in the documentation? Want to improve
+        existing functionalities? The contributing guidelines will guide
+        you through the process of improving pyufunc.
+
+        +++
+
+        .. button-ref:: development
+            :ref-type: ref
+            :click-parent:
+            :color: secondary
+            :expand:
+
+            To the development guide
+
+
+.. toctree::
+    :maxdepth: 3
+    :hidden:
+    :titlesonly:
+
+
+    getting_started/index
+    user_guide/index
+    reference/index
+    development/index
+    whatsnew/index
+    acknowledgement/index