📚 update documentation and pump up its version
This commit is contained in:
parent
8edce68272
commit
7326d6e39a
|
@ -4,7 +4,7 @@ configuration:
|
||||||
- "commons/templates"
|
- "commons/templates"
|
||||||
- "setupmobans/templates"
|
- "setupmobans/templates"
|
||||||
- ".moban.d"
|
- ".moban.d"
|
||||||
configuration: pyexcel_io.yaml
|
configuration: pyexcel-io.yml
|
||||||
targets:
|
targets:
|
||||||
- "docs/source/conf.py": "docs/source/conf.py"
|
- "docs/source/conf.py": "docs/source/conf.py"
|
||||||
- setup.py: setup.py
|
- setup.py: setup.py
|
||||||
|
|
|
@ -4,6 +4,7 @@ notifications:
|
||||||
email: false
|
email: false
|
||||||
python:
|
python:
|
||||||
- pypy-5.3.1
|
- pypy-5.3.1
|
||||||
|
- 3.7-dev
|
||||||
- 3.6
|
- 3.6
|
||||||
- 3.5
|
- 3.5
|
||||||
- 3.4
|
- 3.4
|
||||||
|
|
|
@ -1,6 +1,16 @@
|
||||||
Change log
|
Change log
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
|
0.5.8 - unreleased
|
||||||
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
fixed
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
#. `#49 <https://github.com/pyexcel/pyexcel-io/issues/49>`_, support additional
|
||||||
|
options when detecting float values in csv format. default_float_nan,
|
||||||
|
ignore_nan_text
|
||||||
|
|
||||||
0.5.7 - 02.05.2018
|
0.5.7 - 02.05.2018
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
4
LICENSE
4
LICENSE
|
@ -13,7 +13,7 @@ that the following conditions are met:
|
||||||
and/or other materials provided with the distribution.
|
and/or other materials provided with the distribution.
|
||||||
|
|
||||||
* Neither the name of 'pyexcel-io' nor the names of the contributors
|
* Neither the name of 'pyexcel-io' nor the names of the contributors
|
||||||
may not be used to endorse or promote products derived from this software
|
may be used to endorse or promote products derived from this software
|
||||||
without specific prior written permission.
|
without specific prior written permission.
|
||||||
|
|
||||||
THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND
|
THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND
|
||||||
|
@ -27,4 +27,4 @@ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||||
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
||||||
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||||
SOFTWARE AND DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
|
SOFTWARE AND DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
|
||||||
DAMAGE.
|
DAMAGE.
|
||||||
|
|
|
@ -1,6 +1,12 @@
|
||||||
name: pyexcel-io
|
name: pyexcel-io
|
||||||
organisation: pyexcel
|
organisation: pyexcel
|
||||||
releases:
|
releases:
|
||||||
|
- changes:
|
||||||
|
- action: fixed
|
||||||
|
details:
|
||||||
|
- '`#49`, support additional options when detecting float values in csv format. default_float_nan, ignore_nan_text'
|
||||||
|
date: unreleased
|
||||||
|
version: 0.5.8
|
||||||
- changes:
|
- changes:
|
||||||
- action: fixed
|
- action: fixed
|
||||||
details:
|
details:
|
||||||
|
|
|
@ -4,26 +4,184 @@ DESCRIPTION = (
|
||||||
'format and to/from databases' +
|
'format and to/from databases' +
|
||||||
''
|
''
|
||||||
)
|
)
|
||||||
extensions = [
|
# -*- coding: utf-8 -*-
|
||||||
'sphinx.ext.autodoc',
|
#
|
||||||
'sphinx.ext.doctest',
|
# Configuration file for the Sphinx documentation builder.
|
||||||
'sphinx.ext.intersphinx',
|
#
|
||||||
'sphinx.ext.viewcode',
|
# This file does only contain a selection of the most common options. For a
|
||||||
'sphinx.ext.autosummary'
|
# full list see the documentation:
|
||||||
]
|
# http://www.sphinx-doc.org/en/master/config
|
||||||
intersphinx_mapping = {
|
|
||||||
'pyexcel': ('http://pyexcel.readthedocs.io/en/latest/', None),
|
# -- Path setup --------------------------------------------------------------
|
||||||
}
|
|
||||||
templates_path = ['_templates']
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
source_suffix = '.rst'
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
master_doc = 'index'
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
|
#
|
||||||
|
# import os
|
||||||
|
# import sys
|
||||||
|
# sys.path.insert(0, os.path.abspath('.'))
|
||||||
|
|
||||||
|
# -- Project information -----------------------------------------------------
|
||||||
|
|
||||||
project = u'pyexcel-io'
|
project = u'pyexcel-io'
|
||||||
copyright = u'2015-2018 Onni Software Ltd.'
|
copyright = u'2015-2018 Onni Software Ltd.'
|
||||||
version = '0.5.7'
|
author = u'C.W.'
|
||||||
release = '0.5.7'
|
|
||||||
|
# The short X.Y version
|
||||||
|
version = u'0.5.7'
|
||||||
|
# The full version, including alpha/beta/rc tags
|
||||||
|
release = u'0.5.8'
|
||||||
|
|
||||||
|
|
||||||
|
# -- 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.viewcode',]
|
||||||
|
|
||||||
|
# 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 = 'en'
|
||||||
|
|
||||||
|
# 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 = []
|
exclude_patterns = []
|
||||||
|
|
||||||
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
pygments_style = 'sphinx'
|
pygments_style = 'sphinx'
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for HTML output -------------------------------------------------
|
||||||
|
|
||||||
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
|
# a list of builtin themes.
|
||||||
|
#
|
||||||
|
html_theme = 'alabaster'
|
||||||
|
|
||||||
|
# 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 = {}
|
||||||
|
|
||||||
|
# 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 = 'pyexcel-iodoc'
|
||||||
|
|
||||||
|
|
||||||
|
# -- 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, 'pyexcel-io.tex', u'pyexcel-io Documentation',
|
||||||
|
u'Onni Software Ltd.', '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, 'pyexcel-io', u'pyexcel-io 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, 'pyexcel-io', u'pyexcel-io Documentation',
|
||||||
|
author, 'pyexcel-io', '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 = {'https://docs.python.org/': None}
|
||||||
|
# TODO: html_theme not configurable upstream
|
||||||
html_theme = 'default'
|
html_theme = 'default'
|
||||||
|
|
||||||
|
|
||||||
|
@ -31,19 +189,8 @@ def setup(app):
|
||||||
app.add_stylesheet('theme_overrides.css')
|
app.add_stylesheet('theme_overrides.css')
|
||||||
|
|
||||||
|
|
||||||
html_static_path = ['_static']
|
|
||||||
htmlhelp_basename = 'pyexcel-iodoc'
|
# TODO: DESCRIPTION not configurable upstream
|
||||||
latex_elements = {}
|
|
||||||
latex_documents = [
|
|
||||||
('index', 'pyexcel-io.tex',
|
|
||||||
'pyexcel-io Documentation',
|
|
||||||
'Onni Software Ltd.', 'manual'),
|
|
||||||
]
|
|
||||||
man_pages = [
|
|
||||||
('index', 'pyexcel-io',
|
|
||||||
'pyexcel-io Documentation',
|
|
||||||
[u'Onni Software Ltd.'], 1)
|
|
||||||
]
|
|
||||||
texinfo_documents = [
|
texinfo_documents = [
|
||||||
('index', 'pyexcel-io',
|
('index', 'pyexcel-io',
|
||||||
'pyexcel-io Documentation',
|
'pyexcel-io Documentation',
|
||||||
|
@ -51,3 +198,6 @@ texinfo_documents = [
|
||||||
DESCRIPTION,
|
DESCRIPTION,
|
||||||
'Miscellaneous'),
|
'Miscellaneous'),
|
||||||
]
|
]
|
||||||
|
intersphinx_mapping.update({
|
||||||
|
'pyexcel': ('http://pyexcel.readthedocs.io/en/latest/', None),
|
||||||
|
})
|
||||||
|
|
|
@ -10,6 +10,7 @@
|
||||||
:Source code: http://github.com/pyexcel/pyexcel-io.git
|
:Source code: http://github.com/pyexcel/pyexcel-io.git
|
||||||
:Issues: http://github.com/pyexcel/pyexcel-io/issues
|
:Issues: http://github.com/pyexcel/pyexcel-io/issues
|
||||||
:License: New BSD License
|
:License: New BSD License
|
||||||
|
:Development: |release|
|
||||||
:Released: |version|
|
:Released: |version|
|
||||||
:Generated: |today|
|
:Generated: |today|
|
||||||
|
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
overrides: "pyexcel.yaml"
|
overrides: "pyexcel.yaml"
|
||||||
name: "pyexcel-io"
|
name: "pyexcel-io"
|
||||||
nick_name: io
|
nick_name: io
|
||||||
version: 0.5.7
|
version: 0.5.8
|
||||||
current_version: 0.5.7
|
current_version: 0.5.8
|
||||||
release: 0.5.7
|
release: 0.5.7
|
||||||
dependencies:
|
dependencies:
|
||||||
- ordereddict;python_version<"2.7"
|
- ordereddict;python_version<"2.7"
|
13
setup.py
13
setup.py
|
@ -1,4 +1,6 @@
|
||||||
# Template by setupmobans
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
# Template by pypi-mobans
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
import codecs
|
import codecs
|
||||||
|
@ -9,7 +11,7 @@ PY26 = PY2 and sys.version_info[1] < 7
|
||||||
|
|
||||||
NAME = 'pyexcel-io'
|
NAME = 'pyexcel-io'
|
||||||
AUTHOR = 'C.W.'
|
AUTHOR = 'C.W.'
|
||||||
VERSION = '0.5.7'
|
VERSION = '0.5.8'
|
||||||
EMAIL = 'wangc_2011@hotmail.com'
|
EMAIL = 'wangc_2011@hotmail.com'
|
||||||
LICENSE = 'New BSD'
|
LICENSE = 'New BSD'
|
||||||
DESCRIPTION = (
|
DESCRIPTION = (
|
||||||
|
@ -20,6 +22,7 @@ URL = 'https://github.com/pyexcel/pyexcel-io'
|
||||||
DOWNLOAD_URL = '%s/archive/0.5.7.tar.gz' % URL
|
DOWNLOAD_URL = '%s/archive/0.5.7.tar.gz' % URL
|
||||||
FILES = ['README.rst', 'CHANGELOG.rst']
|
FILES = ['README.rst', 'CHANGELOG.rst']
|
||||||
KEYWORDS = [
|
KEYWORDS = [
|
||||||
|
'python',
|
||||||
'API',
|
'API',
|
||||||
'tsv',
|
'tsv',
|
||||||
'tsvz',
|
'tsvz',
|
||||||
|
@ -27,12 +30,9 @@ KEYWORDS = [
|
||||||
'csvz',
|
'csvz',
|
||||||
'django',
|
'django',
|
||||||
'sqlalchemy',
|
'sqlalchemy',
|
||||||
'python'
|
|
||||||
]
|
]
|
||||||
|
|
||||||
CLASSIFIERS = [
|
CLASSIFIERS = [
|
||||||
'Topic :: Office/Business',
|
|
||||||
'Topic :: Utilities',
|
|
||||||
'Topic :: Software Development :: Libraries',
|
'Topic :: Software Development :: Libraries',
|
||||||
'Programming Language :: Python',
|
'Programming Language :: Python',
|
||||||
'Intended Audience :: Developers',
|
'Intended Audience :: Developers',
|
||||||
|
@ -140,7 +140,8 @@ def read_files(*files):
|
||||||
|
|
||||||
def read(afile):
|
def read(afile):
|
||||||
"""Read a file into setup"""
|
"""Read a file into setup"""
|
||||||
with codecs.open(afile, 'r', 'utf-8') as opened_file:
|
the_relative_file = os.path.join(HERE, afile)
|
||||||
|
with codecs.open(the_relative_file, 'r', 'utf-8') as opened_file:
|
||||||
content = filter_out_test_code(opened_file)
|
content = filter_out_test_code(opened_file)
|
||||||
content = "".join(list(content))
|
content = "".join(list(content))
|
||||||
return content
|
return content
|
||||||
|
|
Loading…
Reference in New Issue