Skip to content

Commit adb3518

Browse files
chfwchfw
committed
🚜 re-organising file structure
0 parents  commit adb3518

File tree

9 files changed

+424
-0
lines changed

9 files changed

+424
-0
lines changed

‎LICENSE

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Copyright (c) 2018 by Onni Software Ltd. and its contributors
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms of the software as well
5+
as documentation, with or without modification, are permitted provided
6+
that the following conditions are met:
7+
8+
* Redistributions of source code must retain the above copyright notice, this
9+
list of conditions and the following disclaimer.
10+
11+
* Redistributions in binary form must reproduce the above copyright notice,
12+
this list of conditions and the following disclaimer in the documentation
13+
and/or other materials provided with the distribution.
14+
15+
* Neither the name of 'pypi-mobans' nor the names of the contributors
16+
may be used to endorse or promote products derived from this software
17+
without specific prior written permission.
18+
19+
THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND
20+
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
21+
NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
23+
OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24+
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25+
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26+
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27+
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28+
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29+
SOFTWARE AND DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
30+
DAMAGE.

‎MANIFEST.in

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
include README.rst
2+
include CHANGELOG.rst
3+
include pypi_mobans/resources/templates/*
4+
recursive-include pypi_mobans/resources/templates/gitignore *.*
5+
include pypi_mobans/resources/templates/docs/*
6+
include pypi_mobans/resources/templates/tests/*
7+
include pypi_mobans/resources/config/*

‎Makefile

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
all: test
2+
3+
test:
4+
bash test.sh
5+
6+
document:
7+
bash document.sh

‎docs/source/conf.py

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
# -*- coding: utf-8 -*-
2+
DESCRIPTION = (
3+
'Scaffolding mobans for your Python project.' +
4+
''
5+
)
6+
# -*- coding: utf-8 -*-
7+
#
8+
# Configuration file for the Sphinx documentation builder.
9+
#
10+
# This file does only contain a selection of the most common options. For a
11+
# full list see the documentation:
12+
# http://www.sphinx-doc.org/en/master/config
13+
14+
# -- Path setup --------------------------------------------------------------
15+
16+
# If extensions (or modules to document with autodoc) are in another directory,
17+
# add these directories to sys.path here. If the directory is relative to the
18+
# documentation root, use os.path.abspath to make it absolute, like shown here.
19+
#
20+
# import os
21+
# import sys
22+
# sys.path.insert(0, os.path.abspath('.'))
23+
24+
# -- Project information -----------------------------------------------------
25+
26+
project = u'pypi-mobans'
27+
copyright = u'2018 Onni Software Ltd.'
28+
author = u'C.W.'
29+
30+
# The short X.Y version
31+
version = u'0.0.0'
32+
# The full version, including alpha/beta/rc tags
33+
release = u'0.0.1'
34+
35+
36+
# -- General configuration ---------------------------------------------------
37+
38+
# If your documentation needs a minimal Sphinx version, state it here.
39+
#
40+
# needs_sphinx = '1.0'
41+
42+
# Add any Sphinx extension module names here, as strings. They can be
43+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
44+
# ones.
45+
extensions = [
46+
'sphinx.ext.autodoc',
47+
'sphinx.ext.doctest',
48+
'sphinx.ext.intersphinx',
49+
'sphinx.ext.viewcode',
50+
]
51+
52+
# Add any paths that contain templates here, relative to this directory.
53+
templates_path = ['_templates']
54+
55+
# The suffix(es) of source filenames.
56+
# You can specify multiple suffix as a list of string:
57+
#
58+
# source_suffix = ['.rst', '.md']
59+
source_suffix = '.rst'
60+
61+
# The master toctree document.
62+
master_doc = 'index'
63+
64+
# The language for content autogenerated by Sphinx. Refer to documentation
65+
# for a list of supported languages.
66+
#
67+
# This is also used if you do content translation via gettext catalogs.
68+
# Usually you set "language" from the command line for these cases.
69+
language = 'en'
70+
71+
# List of patterns, relative to source directory, that match files and
72+
# directories to ignore when looking for source files.
73+
# This pattern also affects html_static_path and html_extra_path.
74+
exclude_patterns = []
75+
76+
# The name of the Pygments (syntax highlighting) style to use.
77+
pygments_style = 'sphinx'
78+
79+
80+
# -- Options for HTML output -------------------------------------------------
81+
82+
# The theme to use for HTML and HTML Help pages. See the documentation for
83+
# a list of builtin themes.
84+
#
85+
html_theme = 'alabaster'
86+
87+
# Theme options are theme-specific and customize the look and feel of a theme
88+
# further. For a list of options available for each theme, see the
89+
# documentation.
90+
#
91+
# html_theme_options = {}
92+
93+
# Add any paths that contain custom static files (such as style sheets) here,
94+
# relative to this directory. They are copied after the builtin static files,
95+
# so a file named "default.css" will overwrite the builtin "default.css".
96+
html_static_path = ['_static']
97+
98+
# Custom sidebar templates, must be a dictionary that maps document names
99+
# to template names.
100+
#
101+
# The default sidebars (for documents that don't match any pattern) are
102+
# defined by theme itself. Builtin themes are using these templates by
103+
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
104+
# 'searchbox.html']``.
105+
#
106+
# html_sidebars = {}
107+
108+
109+
# -- Options for HTMLHelp output ---------------------------------------------
110+
111+
# Output file base name for HTML help builder.
112+
htmlhelp_basename = 'pypi-mobansdoc'
113+
114+
115+
# -- Options for LaTeX output ------------------------------------------------
116+
117+
latex_elements = {
118+
# The paper size ('letterpaper' or 'a4paper').
119+
#
120+
# 'papersize': 'letterpaper',
121+
122+
# The font size ('10pt', '11pt' or '12pt').
123+
#
124+
# 'pointsize': '10pt',
125+
126+
# Additional stuff for the LaTeX preamble.
127+
#
128+
# 'preamble': '',
129+
130+
# Latex figure (float) alignment
131+
#
132+
# 'figure_align': 'htbp',
133+
}
134+
135+
# Grouping the document tree into LaTeX files. List of tuples
136+
# (source start file, target name, title,
137+
# author, documentclass [howto, manual, or own class]).
138+
latex_documents = [
139+
(master_doc, 'pypi-mobans.tex', u'pypi-mobans Documentation',
140+
u'Onni Software Ltd.', 'manual'),
141+
]
142+
143+
144+
# -- Options for manual page output ------------------------------------------
145+
146+
# One entry per manual page. List of tuples
147+
# (source start file, name, description, authors, manual section).
148+
man_pages = [
149+
(master_doc, 'pypi-mobans', u'pypi-mobans Documentation',
150+
[author], 1)
151+
]
152+
153+
154+
# -- Options for Texinfo output ----------------------------------------------
155+
156+
# Grouping the document tree into Texinfo files. List of tuples
157+
# (source start file, target name, title, author,
158+
# dir menu entry, description, category)
159+
texinfo_documents = [
160+
(master_doc, 'pypi-mobans', u'pypi-mobans Documentation',
161+
author, 'pypi-mobans', 'One line description of project.',
162+
'Miscellaneous'),
163+
]
164+
165+
# -- Extension configuration -------------------------------------------------
166+
# -- Options for intersphinx extension ---------------------------------------
167+
168+
# Example configuration for intersphinx: refer to the Python standard library.
169+
intersphinx_mapping = {'https://docs.python.org/': None}
170+
# TODO: html_theme not configurable upstream
171+
html_theme = 'default'
172+
173+
# TODO: DESCRIPTION not configurable upstream
174+
texinfo_documents = [
175+
('index', 'pypi-mobans',
176+
'pypi-mobans Documentation',
177+
'Onni Software Ltd.', 'pypi-mobans',
178+
DESCRIPTION,
179+
'Miscellaneous'),
180+
]
181+
intersphinx_mapping.update({
182+
})

‎pypi_mobans/__init__.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# flake8: noqa
2+
import os
3+
from pypi_mobans._version import __version__
4+
from pypi_mobans._version import __author__
5+
from lml.plugin import PluginInfo
6+
7+
8+
@PluginInfo('library', tags=['setupmobans', 'pypi', 'pypimobans'])
9+
class Pypkg():
10+
def __init__(self):
11+
__package_path__ = os.path.dirname(__file__)
12+
self.resources_path = os.path.join(
13+
__package_path__, "resources")

‎pypi_mobans/_version.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
__version__ = "0.0.1"
2+
__author__ = "C.W."

‎requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
lml

‎setup.cfg

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[bdist_wheel]
2+
universal = 1

0 commit comments

Comments
 (0)