Add documentation

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## [v1.0.0](https://github.com/metastore-developers/metastore/releases/tag/v1.0.0) (2022-04-01)
 
-### **New features**
+### New features
 
 - Distributed processing
 - Data lineage

README.md

@@ -1,7 +1,21 @@
+<p align="left">
+    <a href="https://github.com/metastore-developers/metastore" title="Metastore">
+        <img src="docs/_static/images/logo.svg" width="128px"/>
+    </a>
+</p>
+
+[![Releases](https://img.shields.io/github/v/release/metastore-developers/metastore?color=blue)](https://github.com/metastore-developers/metastore/releases)
+[![Issues](https://img.shields.io/github/issues/metastore-developers/metastore?color=blue)](https://github.com/metastore-developers/metastore/issues)
+[![Pull requests](https://img.shields.io/github/issues-pr/metastore-developers/metastore?color=blue)](https://github.com/metastore-developers/metastore/pulls)
+[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://metastore.readthedocs.io)
+[![License](https://img.shields.io/pypi/l/metastore?color=blue)](LICENSE.md)
+
 # Metastore
 
 Metastore Python SDK.
 
+Feature store and data catalog for machine learning.
+
 ## Prerequisites
 
 * [Python (>=3.7.0)](https://www.python.org)
@@ -66,7 +80,7 @@ Build documentation:
 
 ```
 cd docs/
-sphinx-build -b html source/ build/
+sphinx-build -b html . build/
 ```
 
 ## Changelog

docs/source/_static/styles/custom.css → docs/_static/styles/custom.css

@@ -37,7 +37,7 @@ div.deprecated {
 div.deprecated p {
     margin: 0 !important;
     padding: 0 1.4rem !important;
-    margin-top: .4em !important;
+    margin-top: 0.4em !important;
     color: rgba(var(--pst-color-paragraph), 1) !important;
     display: block !important;
 }
@@ -46,8 +46,12 @@ div.deprecated p {
     font-weight: bold;
 }
 
+.navbar-brand {
+    padding: 0.6rem 0 !important;
+}
+
 .navbar-toggler {
-    margin: .5rem !important;
+    margin: 0.5rem !important;
 }
 
 @media screen and (min-width: 960px), screen and (max-width: 530px) {

docs/source/_templates/navbar-logo.html → docs/_templates/navbar-logo.html

@@ -2,31 +2,31 @@
 {% if not theme_logo_link %}
 <a class="navbar-brand" href="{{ pathto(master_doc) }}">
     <img src="{{ pathto('_static/' + logo, 1) }}" class="logo mx-2" alt="logo">
-    <p class="title d-inline mr-2">{{ project }}</p>
+    <p class="title font-weight-bold d-inline mr-2">{{ project }}</p>
     <p class="d-inline mr-2">
         <span class="d-table-cell text-truncate small text-muted version-width">{{ version }}</span>
     </p>
 </a>
 {% elif theme_logo_link[:4] == 'http' %}
 <a class="navbar-brand" href="{{ theme_logo_link }}">
     <img src="{{ pathto('_static/' + logo, 1) }}" class="logo mx-2" alt="logo">
-    <p class="title d-inline mr-2">{{ project }}</p>
+    <p class="title font-weight-bold d-inline mr-2">{{ project }}</p>
     <p class="d-inline mr-2">
         <span class="d-table-cell text-truncate small text-muted version-width">{{ version }}</span>
     </p>
 </a>
 {% else %}
 <a class="navbar-brand" href="{{ pathto(theme_logo_link) }}">
     <img src="{{ pathto('_static/' + logo, 1) }}" class="logo mx-2" alt="logo">
-    <p class="title d-inline mr-2">{{ project }}</p>
+    <p class="title font-weight-bold d-inline mr-2">{{ project }}</p>
     <p class="d-inline mr-2">
         <span class="d-table-cell text-truncate small text-muted version-width">{{ version }}</span>
     </p>
 </a>
 {% endif %}
 {% else %}
 <a class="navbar-brand" href="{{ pathto(master_doc) }}">
-    <p class="title d-inline mr-2">{{ project }}</p>
+    <p class="title font-weight-bold d-inline mr-2">{{ project }}</p>
     <p class="d-inline mr-2">
         <span class="d-table-cell text-truncate small text-muted version-width">{{ version }}</span>
     </p>

docs/source/api-reference/index.md → docs/api-reference/index.md

@@ -1,8 +1,6 @@
 # API Reference
 
 ```{toctree}
-:maxdepth 2
-:caption Modules:
-
-*
+:maxdepth: 2
+:caption: Modules
 ```

docs/changelog.md

@@ -0,0 +1,2 @@
+```{include} ../CHANGELOG.md
+```

docs/source/conf.py → docs/conf.py

@@ -2,16 +2,20 @@
 
 
 project = metastore.__title__
-release = metastore.__version__
+version = metastore.__version__
 author = metastore.__author__
 copyright = metastore.__copyright__
 
 extensions = [
+    'sphinx.ext.autodoc',
     'myst_parser'
 ]
 source_suffix = {
     '.md': 'markdown'
 }
+exclude_patterns = [
+    'build'
+]
 
 html_theme = 'pydata_sphinx_theme'
 
@@ -38,7 +42,7 @@
         {
             'name': 'PyPI',
             'url': 'https://pypi.org/project/metastore',
-            'icon': 'fas fa-python'
+            'icon': 'fab fa-python'
         }
     ]
 }

docs/contributing.md

@@ -0,0 +1,58 @@
+# Contributing
+
+## Prerequisites
+
+* [Python (>=3.7.0)](https://www.python.org)
+
+## Development
+
+Install package:
+
+```
+pip install -e .[development]
+```
+
+> **Note** Use the `-e, --editable` flag to install the package in development mode.
+
+Format source code:
+
+```
+autopep8 --recursive --in-place setup.py metastore/
+```
+
+Lint source code:
+
+```
+pylint setup.py metastore/
+```
+
+Test package:
+
+```
+pytest
+```
+
+Report test coverage:
+
+```
+pytest --cov
+```
+
+Build package:
+
+```
+python setup.py bdist_wheel
+```
+
+Publish package:
+
+```
+twine upload dist/*
+```
+
+Build documentation:
+
+```
+cd docs/
+sphinx-build -b html . build/
+```

docs/index.md

@@ -0,0 +1,18 @@
+# Metastore Python SDK
+
+```{toctree}
+:maxdepth: 2
+:caption: Contents
+
+overview.md
+contributing.md
+api-reference/index.md
+changelog.md
+license.md
+```
+
+## Indices and tables
+
+* {ref}`genindex`
+* {ref}`modindex`
+* {ref}`search`

docs/license.md

@@ -0,0 +1,4 @@
+# License
+
+```{include} ../LICENSE.md
+```

docs/overview.md

@@ -0,0 +1,23 @@
+# Overview
+
+<p align="left">
+    <a href="https://github.com/metastore-developers/metastore" title="Metastore">
+        <img src="_static/images/logo.svg" width="128px"/>
+    </a>
+</p>
+
+Metastore Python SDK.
+
+Feature store and data catalog for machine learning.
+
+## Prerequisites
+
+* [Python (>=3.7.0)](https://www.python.org)
+
+## Installation
+
+Install package:
+
+```
+pip install metastore
+```