diff --git a/data_migrator/contrib/__init__.py b/data_migrator/contrib/__init__.py index d0d36fd5..29a82225 100644 --- a/data_migrator/contrib/__init__.py +++ b/data_migrator/contrib/__init__.py @@ -1,7 +1,5 @@ #!/usr/bin/python # -*- coding: UTF-8 -*- - ''' -The data_migrator.contrib contains commonly used helper functions, to support in the setup -of specific transformations +Commonly used helper functions, to support in the setup of specific transformations ''' diff --git a/data_migrator/contrib/dutch.py b/data_migrator/contrib/dutch.py index 792e0a5f..d86ae991 100644 --- a/data_migrator/contrib/dutch.py +++ b/data_migrator/contrib/dutch.py @@ -1,5 +1,8 @@ #!/usr/bin/python # -*- coding: UTF-8 -*- +''' +commonly used dutch support functions +''' import re diff --git a/docs/conf.py b/docs/conf.py index 38f2357b..cfe66f4c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,6 @@ import os import sys sys.path.insert(0, os.path.abspath('.')) -from data_migrator.utils import get_docs_version, get_version # -- General configuration ------------------------------------------------ @@ -113,6 +112,8 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +html_show_sourcelink = True +html_show_sphinx = True # -- Options for HTMLHelp output ------------------------------------------ diff --git a/docs/ref/contrib.txt b/docs/ref/contrib.txt index 05166ef1..b9c9505e 100644 --- a/docs/ref/contrib.txt +++ b/docs/ref/contrib.txt @@ -9,6 +9,9 @@ Contrib reference .. automodule:: data_migrator.contrib +contrib.read +============= + ``read_map_from_csv`` --------------------- .. autofunction:: data_migrator.contrib.read.read_map_from_csv @@ -22,5 +25,5 @@ contrib.dutch .. autofunction:: data_migrator.contrib.dutch.clean_phone ``clean_zip_code`` ---------------- +------------------ .. autofunction:: data_migrator.contrib.dutch.clean_zip_code diff --git a/docs/ref/model.txt b/docs/ref/model.txt index 1b86f607..c8615aa1 100644 --- a/docs/ref/model.txt +++ b/docs/ref/model.txt @@ -2,6 +2,9 @@ Model class reference ===================== +.. module:: data_migrator.models.base + :synopsis: Base for model definitions + .. currentmodule:: data_migrator.models This document covers features of the :class:`~data_migrator.models.Model` class.