Merge pull request #4 from TTWShell/docs

docs

Author: TTWShell

.gitignore

@@ -8,6 +8,10 @@ __pycache__/*
 .pytest_cache/*
 .tox/*
 
+docs/_build/*
+docs/_static/*
+docs/_templates/*
+
 hobbit_core.egg-info/*
 dist/*
 build/*

README.md

@@ -1,3 +1,30 @@
 # Hobbit-core
 
-A flask project generator.
+一个生成 flask 项目的工具，包含基础工具集。
+
+# Tree
+
+    .
+    ├── demo
+    │   ├── __init__.py
+    │   ├── config.py
+    │   ├── exts.py
+    │   ├── models
+    │   │   ├── __init__.py
+    │   │   └── example.py
+    │   ├── run.py
+    │   ├── schemas
+    │   │   ├── __init__.py
+    │   │   └── example.py
+    │   ├── utils.py
+    │   └── views
+    │       ├── __init__.py
+    │       └── example.py
+    ├── docs
+    ├── requirements.txt
+    └── tests
+        ├── __init__.py
+        ├── conftest.py
+        └── test_example.py
+
+#

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,203 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+import os
+import sys
+
+ROOT_PATH = os.path.split(os.path.abspath('.'))[0]
+sys.path.insert(0, os.path.join(ROOT_PATH, 'hobbit_core'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'hobbit-core'
+copyright = '2018, Legolas Bloom'
+author = 'Legolas Bloom'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+    'sphinx.ext.napoleon',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'python'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# https://pypi.org/project/Flask-Sphinx-Themes/
+html_theme = 'flask'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+
+html_theme_options = {
+    'github_fork': 'TTWShell/hobbit-core',
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'hobbit-coredoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'hobbit-core.tex', 'hobbit-core Documentation',
+     'Legolas Bloom', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'hobbit-core', 'hobbit-core Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'hobbit-core', 'hobbit-core Documentation',
+     author, 'hobbit-core', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+autodoc_member_order = 'bysource'

docs/index.rst

@@ -0,0 +1,64 @@
+.. hobbit-core documentation master file, created by
+   sphinx-quickstart on Tue Sep 25 15:33:01 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to hobbit-core's documentation!
+=======================================
+
+hobbit_core.hobbit
+==================
+
+hobbit - A flask project generator.
+
+.. autofunction:: hobbit_core.hobbit.bootstrap.startproject
+
+hobbit_core.flask_hobbit
+========================
+
+A flask extension that take care of base utils.
+
+.. automodule:: hobbit_core.flask_hobbit
+   :members:
+   :undoc-members:
+
+flask_hobbit.db
+---------------
+
+.. automodule:: hobbit_core.flask_hobbit.db
+   :members:
+   :undoc-members:
+   :exclude-members: SurrogatePK
+
+   .. autoclass:: SurrogatePK
+       :members: __repr__
+
+flask_hobbit.pagination
+-----------------------
+
+.. automodule:: hobbit_core.flask_hobbit.pagination
+   :members:
+   :undoc-members:
+
+flask_hobbit.schemas
+--------------------
+
+.. automodule:: hobbit_core.flask_hobbit.schemas
+   :members:
+   :undoc-members:
+   :exclude-members: PagedSchema
+
+   .. autoclass:: PagedSchema
+       :members:
+
+flask_hobbit.response
+---------------------
+
+.. automodule:: hobbit_core.flask_hobbit.response
+   :members:
+   :undoc-members:
+
+Indices and tables
+==================
+
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

hobbit_core/flask_hobbit/__init__.py

@@ -9,6 +9,8 @@
 
 
 class HobbitManager:
+    """Customizable utils management.
+    """
 
     def __init__(self, app=None, **kwargs):
         """
@@ -19,6 +21,9 @@ def __init__(self, app=None, **kwargs):
             self.init_app(app, **kwargs)
 
     def init_app(self, app, **kwargs):
+        """
+        app: The Flask application instance.
+        """
         if not isinstance(app, Flask):
             raise TypeError(
                 'flask_hobbit.HobbitManager.init_app(): '