prepare documentation generation

CHANGELOG.md

@@ -0,0 +1 @@
+* initial release

Makefile

@@ -0,0 +1,26 @@
+export GEEKDOC_VERSION ?= latest
+BASE_DIR := docs
+THEME := hugo-geekdoc
+THEME_DIR := $(BASE_DIR)/themes
+
+.PHONY: all
+all: doc
+
+.PHONY: doc
+doc: doc-assets doc-generate
+
+.PHONY: doc-assets
+doc-assets:
+  mkdir -p $(THEME_DIR)/$(THEME)/; \
+  curl -sSL https://github.com/xoxys/$(THEME)/releases/$${GEEKDOC_VERSION}/download/$(THEME).tar.gz | tar -xz -C $(THEME_DIR)/$(THEME)/ --strip-components=1
+
+.PHONY: doc-generate
+doc-generate:
+  cd $(BASE_DIR); \
+  cp templates/usage_index.md content/usage/_index.md; \
+  pydocmd simple corenetworks+ corenetworks.authenticators++ corenetworks.client++ corenetworks.exceptions++ >> content/usage/_index.md
+
+.PHONY: clean
+clean:
+  rm -rf $(THEME_DIR) && \
+  rm -f content/usage/_index.md

corenetworks/__init__.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """Default package."""
 

corenetworks/authenticators.py

@@ -13,7 +13,7 @@ from .exceptions import AuthError
 
 
 class CoreNetworksBasicAuth(AuthBase):
-    """Define token based auth."""
+    """Define login based auth."""
 
     def __init__(self, user, password, endpoint):
         self.user = user

corenetworks/exceptions.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+# -*- coding: utf-8 -*-
 """Custom package exceptions."""
 
 

setup.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 """Setup script for the package."""
 
 import io