nmk-doc 0.3.1__tar.gz → 0.4.0__tar.gz

{nmk-doc-0.3.1/src/nmk_doc.egg-info → nmk-doc-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nmk-doc
-Version: 0.3.1
+Version: 0.4.0
 Summary: Documentation handling plugin for nmk build system
 Home-page: https://github.com/dynod/nmk-doc
 Author: The dynod project

{nmk-doc-0.3.1 → nmk-doc-0.4.0}/setup.cfg

@@ -15,7 +15,7 @@ exclude =
 name = nmk-doc
 author = The dynod project
 maintainer = The dynod project
-version = 0.3.1
+version = 0.4.0
 long_description = file: README.md
 long_description_content_type = text/markdown
 license = Mozilla Public License Version 2.0

{nmk-doc-0.3.1 → nmk-doc-0.4.0}/src/nmk_doc/builders.py

@@ -2,27 +2,8 @@
 Python module for **nmk-doc** plugin builders.
 """
 
-from pathlib import Path
-
 from nmk.model.builder import NmkTaskBuilder
 from nmk.utils import run_with_logs
-from nmk_base.common import TemplateBuilder
-
-
-class NmkDocConfigBuilder(TemplateBuilder):
-    """
-    Builder used to generate doc config files
-    """
-
-    def build(self, template: str):
-        """
-        Called by the **doc.config** and **doc.rtd** tasks, to generate the **sphinx** + **Read The Docs** config files
-
-        :param template: Path to the Jinja template to use for generation**
-        """
-
-        # Just build from template
-        self.build_from_template(Path(template), self.main_output, {})
 
 
 class NmkDocSphinxBuilder(NmkTaskBuilder):

{nmk-doc-0.3.1 → nmk-doc-0.4.0}/src/nmk_doc/doc.yml

@@ -28,13 +28,6 @@ config:
     # Project author (default: shared author config)
     docAuthor: ${projectAuthor}
 
-    # Project version (default: use resolver to deduce from git version)
-    docVersion:
-        __resolver__: nmk_doc.resolvers.NmkDocVersionResolver
-
-    # Project version increment (used to predict next version, from next git tag)
-    docVersionIncrement: "0.1.0"
-
     # Project year
     docYear:
         __resolver__: nmk_doc.resolvers.NmkDocYearResolver
@@ -76,10 +69,9 @@ tasks:
             - setup
         if: ${docInputs}
         input:
-            - ${gitVersionStamp}
             - ${docConfigTemplate}
         output: ${docConfig}
-        builder: nmk_doc.builders.NmkDocConfigBuilder
+        builder: nmk_base.common.TemplateBuilder
         params:
             template: ${docConfigTemplate}
 
@@ -96,7 +88,7 @@ tasks:
             - ${docConfig}
             - ${docRTDConfigTemplate}
         output: ${docRTDConfig}
-        builder: nmk_doc.builders.NmkDocConfigBuilder
+        builder: nmk_base.common.TemplateBuilder
         params:
             template: ${docRTDConfigTemplate}
 

nmk-doc-0.4.0/src/nmk_doc/resolvers.py

@@ -0,0 +1,37 @@
+"""
+Module containing all config item resolvers for **nmk-doc** plugin.
+"""
+from datetime import date
+
+from nmk.model.resolver import NmkIntConfigResolver
+from nmk_base.resolvers import FilesResolver
+
+
+class NmkDocInputsResolver(FilesResolver):
+    """
+    Resolves all files in doc folder
+    """
+
+    @property
+    def folder_config(self) -> str:
+        """
+        Tells **FilesResolver** to search files in **${docPath}** config item.
+        """
+        return "docPath"
+
+
+class NmkDocYearResolver(NmkIntConfigResolver):
+    """
+    Current year resolver
+    """
+
+    def get_value(self, name: str) -> int:
+        """
+        Get today's year.
+
+        :param name: config item name to be resolved
+        :return: current year
+        """
+
+        # Today's year
+        return date.today().year

{nmk-doc-0.3.1 → nmk-doc-0.4.0}/src/nmk_doc/templates/config.py.jinja

@@ -9,7 +9,6 @@
 project = "{{ docName }}"
 copyright = "{{ docYear }}, {{ docAuthor }}"
 author = "{{ docAuthor }}"
-release = "{{ docVersion }}"
 
 # Extensions configuration
 extensions = [{% for extension in docExtensions %}{% if loop.index > 1 %}, {% endif %}"{{ extension }}"{% endfor %}]

{nmk-doc-0.3.1 → nmk-doc-0.4.0/src/nmk_doc.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nmk-doc
-Version: 0.3.1
+Version: 0.4.0
 Summary: Documentation handling plugin for nmk build system
 Home-page: https://github.com/dynod/nmk-doc
 Author: The dynod project

nmk-doc-0.3.1/src/nmk_doc/resolvers.py

@@ -1,102 +0,0 @@
-"""
-Module containing all config item resolvers for **nmk-doc** plugin.
-"""
-import re
-from datetime import date
-
-from nmk.model.resolver import NmkIntConfigResolver, NmkStrConfigResolver
-from nmk_base.resolvers import FilesResolver
-
-DOC_INCREMENT_PATTERN = re.compile("[0-9.]+")
-"""
-Document version increment verification pattern
-"""
-
-
-class NmkDocInputsResolver(FilesResolver):
-    """
-    Resolves all files in doc folder
-    """
-
-    @property
-    def folder_config(self) -> str:
-        """
-        Tells **FilesResolver** to search files in **${docPath}** config item.
-        """
-        return "docPath"
-
-
-class NmkDocVersionResolver(NmkStrConfigResolver):
-    """
-    Documentation version resolver
-    """
-
-    def get_value(self, name: str) -> str:
-        """
-        Get resolved version value.
-        Behavior of the version resolution is:
-          * take git version (see **${gitVersion}** config item description)
-          * if this is a tagged version, simply use it
-          * otherwise deduce last tag and increment it with increment configured in **${docVersionIncrement}** config item
-
-        :param name: config item name to be resolved
-        :return: resolved version
-        """
-
-        # Get git version
-        git_version = self.model.config["gitVersion"].value
-
-        # Check git version segments
-        segments = git_version.split("-")
-        doc_version = segments[0]
-        if len(segments) == 1:
-            # This is a tagged version: use it directly
-            return doc_version
-
-        # Not on a tagged version: let's predict the next one with provided increment
-        increment = self.model.config["docVersionIncrement"].value
-        assert DOC_INCREMENT_PATTERN.match(increment) is not None, f"Invalid docVersionIncrement format: {increment}"
-
-        # Build predicted version
-        doc_version_digits = [int(i) for i in doc_version.split(".")]
-        increment_digits = [int(i) for i in increment.split(".")]
-        assert len(doc_version_digits) == len(
-            increment_digits
-        ), f"Not the same digits count between version deduced from gitVersion ({doc_version}) and docVersionIncrement ({increment})"
-        out_string = ""
-        increment_found = False
-        for d1, d2 in zip(doc_version_digits, increment_digits):
-            # One more digit
-            if len(out_string):
-                out_string += "."
-
-            # Increment?
-            if d2 > 0:
-                # Incremented digit found: do it
-                out_string += str(d1 + d2)
-                increment_found = True
-            elif not increment_found:
-                # Incremented digit not found yet: just keep original digit
-                out_string += str(d1)
-            else:
-                # Post-increment digit: set them all to 0
-                out_string += "0"
-
-        return out_string
-
-
-class NmkDocYearResolver(NmkIntConfigResolver):
-    """
-    Current year resolver
-    """
-
-    def get_value(self, name: str) -> int:
-        """
-        Get today's year.
-
-        :param name: config item name to be resolved
-        :return: current year
-        """
-
-        # Today's year
-        return date.today().year