Update to fail on sphinx errors.

Author: adiroiban

chevah/__init__.py

@@ -0,0 +1,64 @@
+# Copyright (c) 2021 Adi Roiban.
+# See LICENSE for details.
+"""
+Extensions to add custom MFA to SFTPPlus LDAP authentication.
+"""
+from __future__ import unicode_literals
+
+
+class AuthLDAPNoop(object):
+    """
+    This is an LDAP authentication extension that has no extra functionality.
+
+    It servers as a documentation for the extension interface.
+
+    The extension is implicitly started at initialization.
+    """
+
+    def __init__(self, configuration):
+        """
+        Called when the associated LDAP authentication starts.
+
+        :param configuration: A text which can be formatted as JSON.
+            But each extension can parse it as it wants.
+            JSON format is not required. It is only recommended.
+        """
+
+    def stop(self):
+        """
+        Called when the extension is no longer used.
+        """
+
+    def updateCredentials(self, credentials):
+        """
+        Called before BIND to allow mutating the credentials.
+
+        This can be used to mutate the credentials to be used during the
+        BIND operation.
+        """
+
+    def getExtraAttributes(self):
+        """
+        Return the list of extra LDAP attributes to be used during the entry
+        search operation.
+        """
+        return []
+
+    def augmentEntry(self, entry, credentials, ldap_client):
+        """
+        Called after BIND was successful and we got the LDAP entry for the
+        account.
+
+        Raises
+            chevah.server.commons.exception.ServerException
+            on any error condition, with a text containing the error details.
+
+        :param entry: The LDAP entry that was just authenticated.
+        :param credentials: Used for the authorization to LDAP server.
+        :param ldap_client: A LDAP client that is already authenticated and
+            that can be used for further LDAP operations.
+        :param base_dn: The base_dn from which the account was authenticated.
+
+        :return: The augmented LDAP entry on success.
+        """
+        return entry

chevah/server/__init__.py

@@ -18,7 +18,7 @@
   # Netlify will auto install the deps.
   # https://docs.netlify.com/configure-builds/manage-dependencies/#python
   # https://github.com/netlify/build-image/blob/focal/included_software.md
-  command = 'sphinx-build -b html -D html_theme=integrated -A robots="$DOCS_ROBOT" src/doc_source/ deploy'
+  command = 'bash netlify_build.sh'
 
 [build.processing.html]
   # The automatic redirection from /path/folder-> /path/folder/ is disabled

chevah/server/extension/__init__.py

@@ -0,0 +1,2 @@
+# Command to build the docs on netfliy.
+sphinx-build -b html --keep-going -W -D html_theme=integrated -A robots="$DOCS_ROBOT" src/doc_source/ deploy

chevah/server/extension/auth_ldap_noop.py

@@ -28,15 +28,15 @@
 }
 
 
-version = "4.23.0.dev0"
-release = "4.23.0.dev0"
+version = "4.22.0"
+release = "4.22.0"
 
 autodoc_default_flags = ['members']
 primary_domain = 'py'
 
 pdf_documents = [(
     'index',
-    u'SFTPPlus-4.23.0.dev0',
+    u'SFTPPlus-4.22.0',
     u'SFTPPlus Documentation',
     u'ProAtria Team',
     )]

netlify.toml

@@ -13,6 +13,7 @@ cp -r build-server/doc_source $DOCS_ROOT/src/
 cp extension/* $DOCS_ROOT/extension/
 cp -r build-server/lib/python2.7/site-packages/sftpplus_website/sphinx $DOCS_ROOT
 
+echo "Creating extensions for $DOCS_ROOT ..."
 mkdir -p $DOCS_ROOT/chevah/server/extension
 touch $DOCS_ROOT/chevah/__init__.py
 touch $DOCS_ROOT/chevah/server/__init__.py
@@ -21,11 +22,11 @@ cp chevah/server/extension/auth_ldap_noop.py $DOCS_ROOT/chevah/server/extension/
 
 cd $DOCS_ROOT
 rm -rf venv/lib/python2.7/site-packages/chevah
-mv chevah venv/lib/python2.7/site-packages/
+cp -r chevah venv/lib/python2.7/site-packages/
 sed 's/^templates_path.*/templates_path = ["..\/..\/sphinx"]/'g -i src/doc_source/conf.py
 sed 's/^html_theme_path.*/html_theme_path = ["..\/..\/sphinx"]/'g -i src/doc_source/conf.py
 
 rm -rf deploy
 . venv/bin/activate
 pip install -r requirements.txt
-sphinx-build -b html src/doc_source/ deploy
+sphinx-build -b html --keep-going -W src/doc_source/ deploy