nmk-doc 0.1.1__tar.gz → 0.2.0__tar.gz

{nmk-doc-0.1.1/src/nmk_doc.egg-info → nmk-doc-0.2.0}/PKG-INFO

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

{nmk-doc-0.1.1 → nmk-doc-0.2.0}/setup.cfg

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

{nmk-doc-0.1.1 → nmk-doc-0.2.0}/src/nmk_doc/__init__.py

@@ -39,7 +39,6 @@ class NmkDocVersionResolver(VersionResolver):
         Module version accessor
 
         :return: current module version
-        :rtype: str
         """
 
         return __version__

{nmk-doc-0.1.1 → nmk-doc-0.2.0}/src/nmk_doc/builders.py

@@ -11,15 +11,14 @@ from nmk_base.common import TemplateBuilder
 
 class NmkDocConfigBuilder(TemplateBuilder):
     """
-    Builder used to generate the **sphinx** config file
+    Builder used to generate doc config files
     """
 
     def build(self, template: str):
         """
-        Called by the **doc.config** task, to generate the **sphinx** config file
+        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 for **sphinx** config file -- see **${docConfigTemplate}**
-        :type template: str
+        :param template: Path to the Jinja template to use for generation**
         """
 
         # Just build from template
@@ -36,9 +35,7 @@ class NmkDocSphinxBuilder(NmkTaskBuilder):
         Called by the **doc.build** task, to build the **sphinx** documentation
 
         :param source_folder: doc source folder
-        :type source_folder: str
         :param output_folder: doc output folder
-        :type output_folder: str
         """
 
         # Invoke sphinx

{nmk-doc-0.1.1 → nmk-doc-0.2.0}/src/nmk_doc/doc.yml

@@ -48,6 +48,12 @@ config:
     # Doc output folder
     docOutput: ${outputDir}/doc
 
+    # Config file for ReadTheDocs automated build
+    docRTDConfig: ${PROJECTDIR}/.readthedocs.yaml
+
+    # Template file for ReadTheDocs automated build config
+    docRTDConfigTemplate: ${BASEDIR}/templates/readthedocs.yaml.jinja
+
     # Additional venv dependencies (sphinx itself + plugins)
     venvPkgDeps:
         - sphinx
@@ -65,12 +71,31 @@ tasks:
         appendToDeps:
             - setup
         if: ${docInputs}
-        input: ${gitVersionStamp}
+        input:
+            - ${gitVersionStamp}
+            - ${docConfigTemplate}
         output: ${docConfig}
         builder: nmk_doc.builders.NmkDocConfigBuilder
         params:
             template: ${docConfigTemplate}
 
+    # Generate "Read The Docs" configuration file
+    doc.rtd:
+        description: Generate ReadTheDocs config file
+        emoji: ":open_book:.:pencil:"
+        deps:
+            - doc.config
+        appendToDeps:
+            - setup
+        if: ${docInputs}
+        input:
+            - ${docConfig}
+            - ${docRTDConfigTemplate}
+        output: ${docRTDConfig}
+        builder: nmk_doc.builders.NmkDocConfigBuilder
+        params:
+            template: ${docRTDConfigTemplate}
+
     # Build documentation
     doc.build:
         description: Build documentation

{nmk-doc-0.1.1 → nmk-doc-0.2.0}/src/nmk_doc/resolvers.py

@@ -40,9 +40,7 @@ class NmkDocVersionResolver(NmkStrConfigResolver):
           * otherwise deduce last tag and increment it with increment configured in **${docVersionIncrement}** config item
 
         :param name: config item name to be resolved
-        :type name: str
         :return: resolved version
-        :rtype: str
         """
 
         # Get git version
@@ -97,9 +95,7 @@ class NmkDocYearResolver(NmkIntConfigResolver):
         Get today's year.
 
         :param name: config item name to be resolved
-        :type name: str
         :return: current year
-        :rtype: str
         """
 
         # Today's year

nmk-doc-0.2.0/src/nmk_doc/templates/readthedocs.yaml.jinja

@@ -0,0 +1,22 @@
+# Read the Docs configuration file for Sphinx projects
+# Please don't edit: generated by nmk-doc plugin
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "{{ pythonSupportedVersions[-1] }}"
+
+# Build documentation directory with Sphinx
+sphinx:
+  configuration: {{ docConfig }}
+
+# Declare the Python requirements required to build your documentation
+python:
+    install:
+    - requirements: {{ venvRequirements }}
+

{nmk-doc-0.1.1 → nmk-doc-0.2.0/src/nmk_doc.egg-info}/PKG-INFO

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

{nmk-doc-0.1.1 → nmk-doc-0.2.0}/src/nmk_doc.egg-info/SOURCES.txt

@@ -16,4 +16,5 @@ src/nmk_doc.egg-info/dependency_links.txt
 src/nmk_doc.egg-info/requires.txt
 src/nmk_doc.egg-info/top_level.txt
 src/nmk_doc/templates/__init__.py
-src/nmk_doc/templates/config.py.jinja
+src/nmk_doc/templates/config.py.jinja
+src/nmk_doc/templates/readthedocs.yaml.jinja