Compare commits
No commits in common. "56f6527595ae8adfb06d04e153f5ad6ebe06ba8e" and "016d4f120f5ab99af237489339ea5338a1f5dc2e" have entirely different histories.
56f6527595
...
016d4f120f
3
.gitignore
vendored
3
.gitignore
vendored
@ -1,8 +1,7 @@
|
||||
build
|
||||
docs/build
|
||||
dist
|
||||
*.egg-info
|
||||
__pycache__
|
||||
*.e4p
|
||||
py3x.zip
|
||||
.cache
|
||||
|
||||
|
11
Makefile
11
Makefile
@ -7,14 +7,3 @@ clean:
|
||||
zip:
|
||||
zip -r py3x * -i *.py py3x/*.py
|
||||
|
||||
html:
|
||||
make -C docs html
|
||||
|
||||
pdf:
|
||||
make -C docs latexpdf
|
||||
|
||||
tests:
|
||||
py.test-3 tests
|
||||
|
||||
.PHONY: clean zip html pdf tests
|
||||
|
||||
|
@ -1,20 +0,0 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
SPHINXPROJ = py3x
|
||||
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)
|
172
docs/conf.py
172
docs/conf.py
@ -1,172 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
#sys.path.insert(0, os.path.abspath('.'))
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# py3x documentation build configuration file, created by
|
||||
# sphinx-quickstart on Wed Jul 3 22:36:10 2019.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
# 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('..'))
|
||||
|
||||
|
||||
# -- 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.imgmath',
|
||||
'sphinx.ext.ifconfig',
|
||||
'sphinx.ext.githubpages']
|
||||
|
||||
# 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']
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = 'py3x'
|
||||
copyright = '2019, Андрей Астафьев'
|
||||
author = 'Андрей Астафьев'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '0.2.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '0.2.0'
|
||||
|
||||
# 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 = 'ru'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This patterns also effect to html_static_path and html_extra_path
|
||||
exclude_patterns = []
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = False
|
||||
|
||||
|
||||
# -- 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.
|
||||
#
|
||||
# This is required for the alabaster theme
|
||||
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
|
||||
html_sidebars = {
|
||||
'**': [
|
||||
'relations.html', # needs 'show_related': True theme option to display
|
||||
'searchbox.html',
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
# -- Options for HTMLHelp output ------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'py3xdoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
'papersize': 'a4paper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
'pointsize': '12pt',
|
||||
|
||||
# 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, 'py3x.tex', 'py3x Documentation',
|
||||
'Андрей Астафьев', '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, 'py3x', 'py3x 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, 'py3x', 'py3x Documentation',
|
||||
author, 'py3x', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
||||
|
@ -1,25 +0,0 @@
|
||||
.. py3x documentation master file, created by
|
||||
sphinx-quickstart on Wed Jul 3 22:36:10 2019.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to py3x's documentation!
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
.. automodule:: py3x
|
||||
:members:
|
||||
|
||||
.. automodule:: py3x.functions
|
||||
:members:
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
@ -1,21 +1,9 @@
|
||||
print("loading py3x/__init__.py")
|
||||
|
||||
import sys
|
||||
from py3x.functions import parse_args
|
||||
|
||||
def main():
|
||||
""" Main function """
|
||||
print("running function main from py3x/__init__.py")
|
||||
parse_args()
|
||||
|
||||
args = parse_args(sys.argv[1:])
|
||||
|
||||
if args.verbose:
|
||||
if args.input:
|
||||
print("input file name is: {}".format(args.input))
|
||||
if args.output:
|
||||
print("output file name is: {}".format(args.output))
|
||||
else:
|
||||
if args.input:
|
||||
print(args.input)
|
||||
if args.output:
|
||||
print(args.output)
|
||||
|
@ -2,7 +2,7 @@ print("loading py3x/functions.py")
|
||||
|
||||
import argparse
|
||||
|
||||
def parse_args(args):
|
||||
def parse_args():
|
||||
""" Parse command line arguments """
|
||||
print("running function parse_args from py3x/functions.py")
|
||||
|
||||
@ -13,6 +13,15 @@ def parse_args(args):
|
||||
help="Output file name")
|
||||
parser.add_argument("-v", "--verbose", action="store_true",
|
||||
help="Increase output verbosity")
|
||||
args = parser.parse_args(args)
|
||||
return args
|
||||
args = parser.parse_args()
|
||||
if args.verbose:
|
||||
if args.input:
|
||||
print("input file name is: {}".format(args.input))
|
||||
if args.output:
|
||||
print("output file name is: {}".format(args.output))
|
||||
else:
|
||||
if args.input:
|
||||
print(args.input)
|
||||
if args.output:
|
||||
print(args.output)
|
||||
|
||||
|
@ -1,3 +0,0 @@
|
||||
sphinx
|
||||
pytest
|
||||
|
@ -1,19 +0,0 @@
|
||||
import os
|
||||
import sys
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
|
||||
import pytest
|
||||
from py3x.functions import parse_args
|
||||
|
||||
def test_parse_args_verbose():
|
||||
args = parse_args(['-v'])
|
||||
assert args
|
||||
|
||||
def test_parse_args_input():
|
||||
args = parse_args(['-i', 'input'])
|
||||
assert args
|
||||
|
||||
def test_parse_args_unused():
|
||||
with pytest.raises(SystemExit):
|
||||
args = parse_args(['-b'])
|
||||
|
Loading…
x
Reference in New Issue
Block a user