From 5f4a48aa8a585a0bbe789e3f77c10a4b7c3d0eb7 Mon Sep 17 00:00:00 2001 From: John Vandenberg Date: Fri, 8 Jun 2018 02:14:04 +0700 Subject: [PATCH] :arrow_up: moban sync --- .moban.d/custom_setup.py.jj2 | 4 + README.rst | 5 +- docs/source/conf.py | 163 ++++++++++++++++++++++++++++++++--- setup.py | 12 +-- yehua.yaml | 1 + 5 files changed, 166 insertions(+), 19 deletions(-) diff --git a/.moban.d/custom_setup.py.jj2 b/.moban.d/custom_setup.py.jj2 index 487e2b8..8cc9d4d 100644 --- a/.moban.d/custom_setup.py.jj2 +++ b/.moban.d/custom_setup.py.jj2 @@ -1,4 +1,8 @@ {% extends "setup.py.jj2" %} +{%block additional_classifiers%} + 'Topic :: Utilities', +{%endblock %} + {%block platform_block %} {%endblock%} diff --git a/README.rst b/README.rst index d9c9724..3993637 100644 --- a/README.rst +++ b/README.rst @@ -5,8 +5,9 @@ yehua - Let you focus on code, instead of setup scaffolding .. image:: https://api.travis-ci.org/moremoban/yehua.svg?branch=master :target: http://travis-ci.org/moremoban/yehua -.. image:: https://codecov.io/gh/moremoban/yehua/branch/master/graph/badge.svg - :target: https://codecov.io/gh/moremoban/yehua +.. image:: https://codecov.io/github/moremoban/yehua/coverage.png + :target: https://codecov.io/github/moremoban/yehua + .. image:: https://readthedocs.org/projects/yehua/badge/?version=latest :target: http://yehua.readthedocs.org/en/latest/ diff --git a/docs/source/conf.py b/docs/source/conf.py index 6cf1a0b..9dde123 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -4,6 +4,45 @@ 'age.' + '' ) +# -*- 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 +# sys.path.insert(0, os.path.abspath('.')) + +# -- Project information ----------------------------------------------------- + +project = u'yehua' +copyright = u'2017 Onni Software Ltd.' +author = u'C.W.' + +# The short X.Y version +version = u'0.0.3' +# The full version, including alpha/beta/rc tags +release = u'0.0.3' + + +# -- 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', @@ -11,30 +50,128 @@ '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' -project = u'yehua' -copyright = u'2017 Onni Software Ltd.' -version = '0.0.3' -release = '0.0.3' +# 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 = [] + +# The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -html_theme = 'default' + + +# -- 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 = 'yehuadoc' -latex_elements = {} + + +# -- 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 = [ - ('index', 'yehua.tex', - 'yehua Documentation', - 'Onni Software Ltd.', 'manual'), + (master_doc, 'yehua.tex', u'yehua 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 = [ - ('index', 'yehua', - 'yehua Documentation', - [u'Onni Software Ltd.'], 1) + (master_doc, 'yehua', u'yehua 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, 'yehua', u'yehua Documentation', + author, 'yehua', 'One line description of project.', + 'Miscellaneous'), ] + +# -- 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' + +# TODO: DESCRIPTION not configurable upstream texinfo_documents = [ ('index', 'yehua', 'yehua Documentation', @@ -42,3 +179,5 @@ DESCRIPTION, 'Miscellaneous'), ] +intersphinx_mapping.update({ +}) diff --git a/setup.py b/setup.py index 300de1b..185e250 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,6 @@ -# Template by setupmobans +#!/usr/bin/env python3 + +# Template by pypi-mobans import os import sys import codecs @@ -15,7 +17,7 @@ ENTRY_POINTS = { 'console_scripts': [ 'yh = yehua.main:main' - ] + ], } DESCRIPTION = ( 'A command line tool to provide a default scaffolding for a python' + @@ -29,8 +31,6 @@ ] CLASSIFIERS = [ - 'Topic :: Office/Business', - 'Topic :: Utilities', 'Topic :: Software Development :: Libraries', 'Programming Language :: Python', 'Intended Audience :: Developers', @@ -40,6 +40,7 @@ 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', + 'Topic :: Utilities', ] INSTALL_REQUIRES = [ @@ -133,7 +134,8 @@ def read_files(*files): def read(afile): """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 = "".join(list(content)) return content diff --git a/yehua.yaml b/yehua.yaml index 636f349..4a2c66c 100644 --- a/yehua.yaml +++ b/yehua.yaml @@ -11,6 +11,7 @@ copyright_year: 2017 command_line_interface: "yh" entry_point: "yehua.main:main" license: New BSD +branch: master dependencies: - jinja2 - PyYAML