0
0
mirror of https://github.com/thegeeklab/corenetworks.git synced 2024-11-13 00:10:42 +00:00

prepare documentation generation

This commit is contained in:
Robert Kaussow 2020-04-13 15:37:11 +02:00
parent 2d624344f3
commit 4355b7732a
8 changed files with 30 additions and 3 deletions

1
CHANGELOG.md Normal file
View File

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

26
Makefile Normal file
View File

@ -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

View File

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

View File

@ -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

View File

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

0
docs/content/usage/.keep Normal file
View File

View File

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