Skip to content

Commit bc584aa

Browse files
tacaswelltacaswell
committed
ENH: add skeleton
1 parent ac78a56 commit bc584aa

File tree

10 files changed

+421
-0
lines changed

10 files changed

+421
-0
lines changed

‎.gitignore‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
#########################################
2+
# OS-specific temporary and backup files
3+
.DS_Store
4+
5+
#########################################
6+
# Editor temporary/working/backup files #
7+
.#*
8+
[#]*#
9+
*~
10+
*$
11+
*.bak
12+
*.kdev4
13+
.project
14+
.pydevproject
15+
*.swp
16+
.idea
17+
.vscode/
18+
19+
# Compiled source #
20+
###################
21+
*.a
22+
*.com
23+
*.class
24+
*.dll
25+
*.exe
26+
*.o
27+
*.py[ocd]
28+
*.so
29+
30+
# Python files #
31+
################
32+
# setup.py working directory
33+
build
34+
35+
# setup.py dist directory
36+
dist
37+
# Egg metadata
38+
*.egg-info
39+
.eggs
40+
# tox testing tool
41+
.tox
42+
setup.cfg
43+
44+
# OS generated files #
45+
######################
46+
.directory
47+
.gdb_history
48+
.DS_Store?
49+
ehthumbs.db
50+
Icon?
51+
Thumbs.db
52+
53+
# Things specific to this project #
54+
###################################
55+
lib/matplotlib/mpl-data/matplotlib.conf
56+
lib/matplotlib/mpl-data/matplotlibrc
57+
58+
# Documentation generated files #
59+
#################################
60+
# sphinx build directory
61+
doc/_build
62+
doc/api/_as_gen
63+
# autogenerated by sphinx-gallery
64+
doc/examples
65+
doc/gallery
66+
doc/tutorials
67+
doc/modules
68+
doc/pyplots/tex_demo.png
69+
lib/dateutil
70+
examples/*/*.pdf
71+
examples/*/*.png
72+
examples/*/*.svg
73+
examples/*/*.eps
74+
examples/*/*.svgz
75+
examples/tests/*
76+
!examples/tests/backend_driver.py
77+
result_images
78+
79+
# Nose/Pytest generated files #
80+
###############################
81+
.pytest_cache/
82+
.cache/
83+
.coverage
84+
.coverage.*
85+
cover/
86+
.noseids
87+
88+
# Conda files #
89+
###############
90+
__conda_version__.txt
91+
lib/png.lib
92+
lib/z.lib
93+
94+
# Jupyter files #
95+
#################
96+
97+
.ipynb_checkpoints/

‎.travis.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
language: python
2+
sudo: false
3+
4+
cache:
5+
directories:
6+
- $HOME/.cache/pip
7+
- $HOME/.cache/matplotlib
8+
9+
matrix:
10+
fast_finish: true
11+
include:
12+
- python: 3.5
13+
- python: 3.6
14+
- python: nightly
15+
allow_failures:
16+
- python: nightly
17+
18+
19+
install:
20+
- python -m pip install --upgrade pip
21+
- python -m pip install --upgrade codecov coverage
22+
- python -m pip install -ve .
23+
24+
script:
25+
- coverage run python -m pytest
26+
- coverage report -m
27+
- set -e
28+
- codecov

‎doc/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXPROJ = mpl-altair
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎doc/conf.py‎

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

‎doc/index.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. mpl-altair documentation master file, created by
2+
sphinx-quickstart on Sat Jun 16 13:46:36 2018.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to mpl-altair's documentation!
7+
======================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
14+
15+
Indices and tables
16+
==================
17+
18+
* :ref:`genindex`
19+
* :ref:`modindex`
20+
* :ref:`search`

‎doc/make.bat‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
12+
set SPHINXPROJ=mpl-altair
13+
14+
if "%1" == "" goto help
15+
16+
%SPHINXBUILD% >NUL 2>NUL
17+
if errorlevel 9009 (
18+
echo.
19+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
20+
echo.installed, then set the SPHINXBUILD environment variable to point
21+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
22+
echo.may add the Sphinx directory to PATH.
23+
echo.
24+
echo.If you don't have Sphinx installed, grab it from
25+
echo.http://sphinx-doc.org/
26+
exit /b 1
27+
)
28+
29+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
30+
goto end
31+
32+
:help
33+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
34+
35+
:end
36+
popd

‎mplaltair/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
import matplotlib
2+
import altair

‎mplaltair/tests/__init__.py‎

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

‎mplaltair/tests/test_basic.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
def test_import():
2+
import mplaltair
3+
del mplaltair

0 commit comments

Comments
 (0)