Merge c58f939 into d1847fa

thegrill · Nov 2, 2019 · 2ba7f56 · 2ba7f56
2 parents d1847fa + c58f939
commit 2ba7f56
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 3 deletions.
diff --git a/docs/source/Overview.rst b/docs/source/Overview.rst
@@ -4,3 +4,17 @@ Overview
 .. topic:: Grill Names
 
     This package offers Name objects for digital content creation.
+
+----
+
+Digital content encoded in machine-readable formats can be created, viewed and distributed on digital electronics devices without caring how the data is named.
+
+However, for a creative project with the following stages:
+
+``Idea >> Encode >> Distribution``
+
+Going through each stage requires human input, and for that, ease of data tracking and discoverability is a requirement.
+
+Every contribution to the creative project should be uniquely identified. This is done via the :ref:`CGAsset` name in ``the grill``.
+
+Contributions are reworked and iterated over, versions of said contributions should therefore be a first class citizen. This is solved at the filesystem level via the :ref:`CGAssetFile` name.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -46,6 +46,7 @@
               # 'sphinx.ext.githubpages',
               'sphinx.ext.graphviz',
               'sphinx.ext.inheritance_diagram',
+              'sphinx.ext.autosectionlabel',
               'sphinx_autodoc_typehints']
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/grill/__init__.py b/grill/__init__.py
diff --git a/grill/names/__init__.py b/grill/names/__init__.py
@@ -195,7 +195,7 @@ def _defaults(self):
         result.update(version=1, suffix='ext')
         return result
 
-    def get_path_pattern_list(self):
+    def get_path_pattern_list(self) -> typing.List[str]:
         pattern = super().get_pattern_list()
         pattern.append('version')
         return pattern

diff --git a/grill/tokens/ids/tests/__init__.py b/grill/tokens/ids/tests/__init__.py
diff --git a/setup.py b/setup.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 from setuptools import setup, find_namespace_packages
 
-_VERSION = '1.5.1'
+_VERSION = '1.5.2'
 setup(
     name='grill-names',
     version=_VERSION,

diff --git a/grill/names/tests/__init__.py → tests/__init__.py b/grill/names/tests/__init__.py → tests/__init__.py
diff --git a/grill/names/tests/test.py → tests/test_names.py b/grill/names/tests/test.py → tests/test_names.py
diff --git a/grill/tokens/ids/tests/tests.py → tests/test_tokens.py b/grill/tokens/ids/tests/tests.py → tests/test_tokens.py