Generate API reference

.readthedocs.yaml

@@ -6,4 +6,4 @@ python:
         - requirements: docs/requirements.txt
 
 sphinx:
-    configuration: docs/conf.py
+    configuration: docs/metastore/conf.py

README.md

@@ -66,23 +66,17 @@ pytest --cov --cov-fail-under 80
 
 > **Note** Set the `--cov-fail-under` flag to 80% to validate the code coverage metric.
 
-Build package:
+Generate documentation:
 
 ```
-python setup.py bdist_wheel
+sphinx-apidoc -f -e -T -d 2 -o docs/metastore/api-reference/ metastore/
 ```
 
-Publish package:
-
-```
-twine upload dist/*
-```
-
-Build documentation:
+Build documentation (optional):
 
 ```
 cd docs/
-sphinx-build -b html . build/
+sphinx-build -b html metastore/ build/
 ```
 
 ## Documentation

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

@@ -3,4 +3,7 @@
 ```{toctree}
 :maxdepth: 2
 :caption: Modules
+:glob:
+
+*
 ```

docs/metastore/api-reference/metastore.package.rst

@@ -0,0 +1,7 @@
+metastore.package module
+========================
+
+.. automodule:: metastore.package
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/metastore/api-reference/metastore.rst

@@ -0,0 +1,19 @@
+metastore package
+=================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 2
+
+   metastore.package
+   metastore.utils
+
+Module contents
+---------------
+
+.. automodule:: metastore
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/metastore/api-reference/metastore.utils.rst

@@ -0,0 +1,7 @@
+metastore.utils module
+======================
+
+.. automodule:: metastore.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/metastore/changelog.md

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

docs/conf.py → docs/metastore/conf.py

@@ -10,7 +10,13 @@
     'sphinx.ext.autodoc',
     'myst_parser'
 ]
+
+autodoc_default_options = {
+    'special-members': True
+}
+
 source_suffix = {
+    '.rst': 'restructuredtext',
     '.md': 'markdown'
 }
 exclude_patterns = [

docs/contributing.md → docs/metastore/contributing.md

@@ -44,21 +44,15 @@ pytest --cov --cov-fail-under 80
 Set the `--cov-fail-under` flag to 80% to validate the code coverage metric.
 ```
 
-Build package:
+Generate documentation:
 
 ```
-python setup.py bdist_wheel
+sphinx-apidoc -f -e -T -d 2 -o docs/metastore/api-reference/ metastore/
 ```
 
-Publish package:
-
-```
-twine upload dist/*
-```
-
-Build documentation:
+Build documentation (optional):
 
 ```
 cd docs/
-sphinx-build -b html . build/
+sphinx-build -b html metastore/ build/
 ```

docs/metastore/license.md

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

metastore/package.py

@@ -2,12 +2,25 @@
 Package description information.
 '''
 
+#: Package display name.
 __title__ = 'Metastore'
-__version__ = '1.0.0.dev4'
+
+#: Package version.
+__version__ = '1.0.0.dev5'
+
+#: Package description.
 __description__ = 'Metastore Python SDK.'
+
+#: Package author name.
 __author__ = 'Metastore Developers'
+
+#: Package author email.
 __email__ = 'metastoredevelopers@gmail.com'
+
+#: Package license name.
 __license__ = 'BSD-3-Clause'
+
+#: Package copyright.
 __copyright__ = 'Copyright (c) 2022, Metastore Developers. All rights reserved.'
 
 

metastore/utils.py

@@ -9,7 +9,7 @@ def timezone_aware(date: datetime) -> datetime:
     '''
     Convert naive to timezone-aware datetime (UTC timezone).
 
-    Arguments:
+    Parameters:
         date (datetime): Datetime object.
     Returns:
         datetime: A timezone-aware datetime.

setup.py

@@ -12,7 +12,7 @@ def get_package_info(path: str) -> Dict[str, str]:
     '''
     Get package description information.
 
-    Arguments:
+    Parameters:
         path (str): Path to directory defining package main module.
     Returns:
         Dict[str, str]: A dictionary containing package information.

tests/unit/test_utils.py

@@ -7,10 +7,10 @@
 from metastore import utils
 
 
-def test_timezone_aware_should_return_same_timezone_aware_datetime_with_timezone_aware_datetime_argument():  # pylint: disable=C0301
+def test_timezone_aware_should_return_same_timezone_aware_datetime_with_timezone_aware_datetime_parameter():  # pylint: disable=C0301
     '''
     Test converting naive to timezone-aware datetime (UTC timezone)
-    with timezone-aware datetime argument.
+    with timezone-aware datetime parameter.
 
     Raises:
         AssertionError: Expected value does not match the returned value.
@@ -22,10 +22,10 @@ def test_timezone_aware_should_return_same_timezone_aware_datetime_with_timezone
     assert actual_datetime == expected_datetime
 
 
-def test_timezone_aware_should_return_new_timezone_aware_datetime_with_naive_timezone_datetime_argument():  # pylint: disable=C0301
+def test_timezone_aware_should_return_new_timezone_aware_datetime_with_naive_timezone_datetime_parameter():  # pylint: disable=C0301
     '''
     Test converting naive to timezone-aware datetime (UTC timezone)
-    with naive datetime argument.
+    with naive datetime parameter.
 
     Raises:
         AssertionError: Expected value does not match the returned value.