Skip to content
Commits on Source (10)
Expand all Show whitespace changes
Inline Side-by-side
.gitignore
View file @ da72fb9c
SciTEDirectory.properties
.idea
.travis.yml
View file @ da72fb9c
language: python
python:
- 2.6
- 2.7
- "2.7_with_system_site_packages"
- 3.2
- "3.2_with_system_site_packages"
- 3.3
- 3.4
- "2.6"
- "2.7"
- "3.3"
- "3.4"
- "3.5"
- "3.6"
- "3.7-dev"
# "pypy2.7"
- "pypy3.5"
before_install:
- sudo apt-get update -qq
- sudo apt-get install -qq libepr-api2-dev
- pip install -r requirements.txt --use-mirrors
- if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then pip install -U unittest2 --use-mirrors; fi
- sudo apt-get install -qq libepr-api-dev
install: python setup.py build_ext --inplace
install:
- pip install -r requirements.txt
- if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then pip install -U unittest2; fi
- python setup.py build_ext --inplace
script: make PYTHON=python check
Makefile
View file @ da72fb9c
#!/usr/bin/make -f
# -*- coding: utf-8 -*-
# Copyright (C) 2011-2014, Antonio Valentino <antonio.valentino@tiscali.it>
# Copyright (C) 2011-2018, Antonio Valentino <antonio.valentino@tiscali.it>
#
# This file is part of PyEPR.
#
......@@ -54,11 +54,13 @@ eprsrc: epr-api-src LICENSES/epr-api.txt
fullsdist: doc cythonize eprsrc
$(PYTHON) setup.py sdist
upload: doc cythonize eprsrc
$(PYTHON) setup.py sdist upload -s -i 24B76CFE
upload: fullsdist
twine upload dist/pyepr-*.tar.gz
doc:
$(MAKE) -C doc html
$(RM) -r doc/html
mv doc/_build/html doc/html
clean:
$(PYTHON) setup.py clean --all
......
README.txt
View file @ da72fb9c
......@@ -5,8 +5,8 @@ ENVISAT Product Reader Python API
:HomePage: http://avalentino.github.io/pyepr
:Author: Antonio Valentino
:Contact: antonio.valentino@tiscali.it
:Copyright: 2011-2015, Antonio Valentino <antonio.valentino@tiscali.it>
:Version: 0.9.3
:Copyright: 2011-2018, Antonio Valentino <antonio.valentino@tiscali.it>
:Version: 0.9.4
Introduction
......@@ -35,7 +35,7 @@ Requirements
In order to use PyEPR it is needed that the following software are
correctly installed and configured:
* Python2_ >= 2.6 or Python3_ >= 3.1
* Python2_ >= 2.6 or Python3_ >= 3.1 (including PyPy_)
* numpy_ >= 1.5.0
* `EPR API`_ >= 2.2 (optional, since PyEPR 0.7 the source tar-ball comes
with a copy of the PER C API sources)
......@@ -45,6 +45,7 @@ correctly installed and configured:
.. _Python2: Python_
.. _Python3: Python_
.. _PyPy: http://pypy.orgv
.. _numpy: http://www.numpy.org
.. _gcc: http://gcc.gnu.org
.. _Cython: http://cython.org
......@@ -83,7 +84,7 @@ or::
$ pip install -U --prefix=<TARGET DIRECTORY>
PyEPR_ can be installed from the source tar.ball using the following
PyEPR_ can be installed from the source tar-ball using the following
command::
$ python setup.py install
......@@ -99,7 +100,7 @@ To install PyEPR_ in a non-standard path::
License
=======
Copyright (C) 2011-2015 Antonio Valentino <antonio.valentino@tiscali.it>
Copyright (C) 2011-2018 Antonio Valentino <antonio.valentino@tiscali.it>
PyEPR is free software: you can redistribute it and/or modify
it under the terms of the `GNU General Public License`_ as published by
......
debian/changelog
View file @ da72fb9c
pyepr (0.9.3-6) UNRELEASED; urgency=medium
pyepr (0.9.4-1) unstable; urgency=medium
[ Bas Couwenberg ]
* Update Vcs-* URLs for Salsa.
* Bump Standards-Version to 4.1.4, no changes.
-- Bas Couwenberg <sebastic@debian.org> Sat, 31 Mar 2018 12:50:30 +0200
[ Antonio Valentino ]
* New upstream release.
* Set Multi-Arch: same for pythpn(3)-epr(-dbg) packages.
* debian/rules
- update installdoc rule
* debian/patch
- refresh all parches
* Install examples.
-- Antonio Valentino <antonio.valentino@tiscali.it> Mon, 30 Apr 2018 08:24:31 +0000
pyepr (0.9.3-5) unstable; urgency=medium
......
debian/control
View file @ da72fb9c
......@@ -32,6 +32,7 @@ X-Python3-Version: >= 3.2
Package: python-epr
Architecture: any
Multi-Arch: same
Depends: ${misc:Depends},
${python:Depends},
${shlibs:Depends},
......@@ -53,6 +54,7 @@ Description: Python ENVISAT Product Reader API (Python 2)
Package: python-epr-dbg
Section: debug
Architecture: any
Multi-Arch: same
Depends: ${misc:Depends},
${python:Depends},
${shlibs:Depends},
......@@ -73,6 +75,7 @@ Description: Python ENVISAT Product Reader API (debug extension for Python 2)
Package: python3-epr
Architecture: any
Multi-Arch: same
Depends: ${misc:Depends},
${python3:Depends},
${shlibs:Depends},
......@@ -94,6 +97,7 @@ Description: Python ENVISAT Product Reader API (Python 3)
Package: python3-epr-dbg
Section: debug
Architecture: any
Multi-Arch: same
Depends: ${misc:Depends},
${python3:Depends},
${shlibs:Depends},
......
debian/patches/0001-Only-use-local-files-for-generating-sphinx-doc.patch
View file @ da72fb9c
......@@ -7,34 +7,38 @@ point to local object.inv files.
This makes the package self contained and no download attempt
happens any longer (Closes: #726859).
---
doc/conf.py | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
doc/conf.py | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/doc/conf.py b/doc/conf.py
index 3d21ca8..3d60c09 100644
index 0c23523..795fd91 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -130,8 +130,10 @@ extlinks = {
@@ -139,10 +139,10 @@ html_sidebars = {
'relations.html',
'sourcelink.html',
'searchbox.html',
- 'ohloh.html',
- 'pypi.html',
- 'travis-ci.html',
- 'appveyor.html',
+ # 'ohloh.html',
+ # 'pypi.html',
+ # 'travis-ci.html',
+ # 'appveyor.html',
],
}
@@ -249,8 +249,10 @@ extlinks = {
# Intersphinx
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
- 'python': ('https://docs.python.org/3', None),
- 'numpy': ('http://docs.scipy.org/doc/numpy', None),
- 'numpy': ('https://docs.scipy.org/doc/numpy', None),
+ 'python': ('https://docs.python.org/3',
+ '/usr/share/doc/python3-doc/html/objects.inv'),
+ 'numpy': ('http://docs.scipy.org/doc/numpy',
+ 'numpy': ('https://docs.scipy.org/doc/numpy',
+ '/usr/share/doc/python-numpy-doc/html/objects.inv'),
}
@@ -188,8 +190,8 @@ html_last_updated_fmt = '%b %d, %Y'
# Custom sidebar templates, maps document names to template names.
html_sidebars = {
'index': ['globaltoc.html', 'relations.html', 'sourcelink.html',
- 'searchbox.html', 'ohloh.html', 'pypi.html',
- 'travis-ci.html', 'appveyor.html'],
+ 'searchbox.html'] # , 'ohloh.html', 'pypi.html',
+ # 'travis-ci.html', 'appveyor.html'],
}
# Additional templates that should be rendered to pages, maps page names to
# If true, `todo` and `todoList` produce output, else they produce nothing.
debian/python-epr-doc.links 0 → 100644
View file @ da72fb9c
usr/share/doc/python-epr/examples usr/share/doc/python-epr/html/_downloads
debian/rules
View file @ da72fb9c
......@@ -76,20 +76,15 @@ endif
override_dh_installdocs:
ifeq (,$(findstring nodoc,$(DEB_BUILD_OPTIONS)))
$(MAKE) -C doc html SPHINXOPTS="$(SPHINXOPTS)"
$(MAKE) SPHINXOPTS="$(SPHINXOPTS)" doc
$(RM) -r doc/html/_downloads
else
mkdir -p doc/html
endif
dh_installdocs -ppython-epr-doc --doc-main-package=python-epr
dh_installdocs --remaining-packages
override_dh_installexamples:
dh_installexamples -ppython-epr-doc --doc-main-package=python-epr
dh_installexamples --remaining-packages
dh_installdocs
.PHONY: override_dh_gencontrol override_dh_auto_clean override_dh_auto_test \
override_dh_strip override_dh_installchangelogs override_dh_compress \
override_dh_sphinxdoc override_dh_installdocs override_dh_installexamples
override_dh_sphinxdoc override_dh_installdocs
doc/Makefile
View file @ da72fb9c
# Makefile for Sphinx documentation
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
SPHINXPROJ = PyEPR
SOURCEDIR = .
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
# Put it first so that "make" without argument is like "make help".
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) html
@echo
@echo "Build finished. The HTML pages are in html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PyEPR.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PyEPR.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/PyEPR"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PyEPR"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
.PHONY: help Makefile
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
# 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)
doc/NEWS.txt
View file @ da72fb9c
Change history
==============
PyEPR 0.9.4 (29/04/2018)
------------------------
* Fix compatibility with cython_ >= 0.28
* PyEPR has been successfully tested with PyPy_
.. _PyPy: https://pypy.org
PyEPR 0.9.3 (02/05/2015)
------------------------
......@@ -101,8 +111,8 @@ PyEPR 0.9 (27/02/2015)
.. _setuptools: https://bitbucket.org/pypa/setuptools
.. _numpy: http://www.numpy.org
.. _Windows: http://windows.microsoft.com
.. _AppVeyor: http://www.appveyor.com
.. _PyPI: https://pypi.python.org/pypi/pyepr
.. _AppVeyor: https://www.appveyor.com
.. _PyPI: https://pypi.org/project/pyepr
PyEPR 0.8.2 (03/08/2014)
......@@ -205,7 +215,7 @@ PyEPR 0.7 (04/08/2013)
This features also makes it easier to install PyEPR using pip_.
The user can still guild PyEPR against a system version of the ERP-API
library simply using the :option:`--epr-api-src` option of the
library simply using the `--epr-api-src` option of the
:file:`setup.py` script with "None"" as value.
The ERP C API included in the source tar-ball is version *2.3dev-pyepr062*,
......@@ -224,7 +234,7 @@ PyEPR 0.6.1 (26/04/2012)
------------------------
* fix compatibility with cython_ 0.16
* added a new option to the setup script (:option:`--epr-api-src`) to build
* added a new option to the setup script (`--epr-api-src`) to build
PyEPR using the EPR-API C sources
......@@ -253,7 +263,7 @@ PyEPR 0.5 (25/04/2011)
* suppressed several constness related warnings
.. _`Python 3`: https://docs.python.org/3
.. _intersphinx: http://sphinx-doc.org/latest/ext/intersphinx.html
.. _intersphinx: http://www.sphinx-doc.org/en/master/ext/intersphinx.html
.. _cython: http://cython.org
......@@ -304,7 +314,7 @@ PyEPR 0.2 (20/03/2011)
* introduced some utility methods to :class:`epr.Product` and
:class:`epr.Record` classes
.. _sphinx: http://sphinx-doc.org
.. _sphinx: http://www.sphinx-doc.org
PyEPR 0.1 (09/03/2011)
......
doc/conf.py
View file @ da72fb9c
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# PyEPR documentation build configuration file, created by
# sphinx-quickstart on Sat Jul 26 10:12:56 2014.
# sphinx-quickstart on Sun Apr 29 18:26:52 2018.
#
# This file is execfile()d with the current directory set to its
# containing dir.
......@@ -12,17 +13,19 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
# 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('sphinxext'))
# -- 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
......@@ -35,7 +38,7 @@ extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
# 'sphinx.ext.coverage',
'sphinx.ext.pngmath',
'sphinx.ext.imgmath',
# 'sphinx.ext.jsmath',
# 'sphinx.ext.mathjax',
# 'sphinx.ext.graphviz',
......@@ -43,6 +46,7 @@ extensions = [
# 'sphinx.ext.refcounting',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
# 'sphinx.ext.githubpages',
'sphinx.ext.extlinks',
'ipython_console_highlighting',
]
......@@ -50,95 +54,57 @@ extensions = [
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.txt'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'PyEPR'
copyright = u'2011-2015, Antonio Valentino'
copyright = u'2011-2018, Antonio Valentino'
author = u'Antonio Valentino'
# 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.9.3'
version = '0.9.4'
# The full version, including alpha/beta/rc tags.
release = version + '.dev0'
release = version # + '.dev0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', 'sphinxext', '**/empty.txt']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = [
'_build',
'Thumbs.db',
'.DS_Store',
'sphinxext',
'**/empty.txt',
]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Extensions configuration --------------------------------------------------
# Autodoc configuration
#autoclass_content = 'both'
#autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance']
# #,'inherited-members']
# Auto summary generation
#autosummary_generate = ['reference']
# Enable todo list reporting
todo_include_todos = True
# External links configuration
extlinks = {
'issue': ('https://github.com/avalentino/pyepr/issues/%s', 'gh-'),
}
# Intersphinx
intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
'numpy': ('http://docs.scipy.org/doc/numpy', None),
}
# -- 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'
html_theme = 'pydoctheme'
# Theme options are theme-specific and customize the look and feel of a theme
......@@ -151,76 +117,40 @@ html_theme_options = {
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['.']
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# 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']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# If this is not None, a ‘Last updated on:’ timestamp is inserted at every
# page bottom, using the given strftime() format.
# The empty string is equivalent to '%b %d, %Y'
# (or a locale-dependent equivalent).
html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
# 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 = {
'index': ['globaltoc.html', 'relations.html', 'sourcelink.html',
'searchbox.html', 'ohloh.html', 'pypi.html',
'travis-ci.html', 'appveyor.html'],
'index': [
'globaltoc.html',
'relations.html',
'sourcelink.html',
'searchbox.html',
'ohloh.html',
'pypi.html',
'travis-ci.html',
'appveyor.html',
],
}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
html_domain_indices = False
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'PyEPRdoc'
......@@ -230,40 +160,30 @@ htmlhelp_basename = 'PyEPRdoc'
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 = [
('index', 'pyepr.tex', u'PyEPR Documentation',
u'Antonio Valentino', 'manual'),
(master_doc, 'pyepr.tex', u'PyEPR Documentation',
author, 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = 'footnote'
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
latex_domain_indices = False
......@@ -273,13 +193,10 @@ latex_domain_indices = False
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'pyepr', u'PyEPR Documentation',
[u'Antonio Valentino'], 1)
(master_doc, 'pyepr', u'PyEPR Documentation',
[author], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
......@@ -287,93 +204,55 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'PyEPR', u'PyEPR Documentation',
u'Antonio Valentino', 'PyEPR', 'One line description of project.',
(master_doc, 'PyEPR', u'PyEPR Documentation',
author, 'PyEPR', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
epub_author = u'Antonio Valentino'
epub_publisher = epub_author
epub_author = author
epub_publisher = author
epub_copyright = copyright
# The basename for the epub file. It defaults to the project name.
#epub_basename = u'PyEPR'
# The HTML theme for the epub output. Since the default themes are not optimized
# for small screen space, using the same theme for HTML and epub output is
# usually not wise. This defaults to 'epub', a theme designed to save visual
# space.
#epub_theme = 'epub'
# The language of the text. It defaults to the language option
# or en if the language is not set.
#epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''
# 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 tuple containing the cover image and cover page html template filenames.
#epub_cover = ()
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
#epub_guide = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []
# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3
# Allow duplicate toc entries.
#epub_tocdup = True
# -- Extensions configuration --------------------------------------------------
# Choose between 'default' and 'includehidden'.
#epub_tocscope = 'default'
# Autodoc configuration
#autoclass_content = 'both'
#autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance']
# #,'inherited-members']
# Fix unsupported image types using the PIL.
#epub_fix_images = False
# Auto summary generation
#autosummary_generate = ['reference']
# Scale large images.
#epub_max_image_width = 0
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#epub_show_urls = 'inline'
# External links configuration
extlinks = {
'issue': ('https://github.com/avalentino/pyepr/issues/%s', 'gh-'),
}
# If false, no index is generated.
#epub_use_index = True
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
'numpy': ('https://docs.scipy.org/doc/numpy', None),
}
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'https://docs.python.org/': None}
doc/index.txt
View file @ da72fb9c
......@@ -12,7 +12,7 @@ ENVISAT Product Reader Python API
:HomePage: http://avalentino.github.io/pyepr
:Author: Antonio Valentino
:Contact: antonio.valentino@tiscali.it
:Copyright: 2011-2015, Antonio Valentino
:Copyright: 2011-2018, Antonio Valentino
:Version: |release|
......@@ -59,18 +59,19 @@ ENVISAT Product Reader Python API
Online documentation for other PyEpr_ versions:
* `latest <https://pyepr.readthedocs.org/en/latest/>`_ development
* `0.9.3 <https://pyepr.readthedocs.org/en/v0.9.3/>`_ (latest stable)
* `0.9.2 <https://pyepr.readthedocs.org/en/v0.9.2/>`_
* `0.9.1 <https://pyepr.readthedocs.org/en/v0.9.1/>`_
* `0.9 <https://pyepr.readthedocs.org/en/v0.9/>`_
* `0.8.2 <https://pyepr.readthedocs.org/en/v0.8.2/>`_
* `0.8.1 <https://pyepr.readthedocs.org/en/v0.8.1/>`_
* `0.8 <https://pyepr.readthedocs.org/en/v0.8/>`_
* `0.7.1 <https://pyepr.readthedocs.org/en/v0.7.1/>`_
* `0.7 <https://pyepr.readthedocs.org/en/v0.7/>`_
* `0.6.1 <https://pyepr.readthedocs.org/en/v0.6.1/>`_
* `0.6 <https://pyepr.readthedocs.org/en/v0.6/>`_
* `latest <https://pyepr.readthedocs.io/en/latest/>`_ development
* `0.9.4 <https://pyepr.readthedocs.io/en/v0.9.4/>`_ (latest stable)
* `0.9.3 <https://pyepr.readthedocs.io/en/v0.9.3/>`_
* `0.9.2 <https://pyepr.readthedocs.io/en/v0.9.2/>`_
* `0.9.1 <https://pyepr.readthedocs.io/en/v0.9.1/>`_
* `0.9 <https://pyepr.readthedocs.io/en/v0.9/>`_
* `0.8.2 <https://pyepr.readthedocs.io/en/v0.8.2/>`_
* `0.8.1 <https://pyepr.readthedocs.io/en/v0.8.1/>`_
* `0.8 <https://pyepr.readthedocs.io/en/v0.8/>`_
* `0.7.1 <https://pyepr.readthedocs.io/en/v0.7.1/>`_
* `0.7 <https://pyepr.readthedocs.io/en/v0.7/>`_
* `0.6.1 <https://pyepr.readthedocs.io/en/v0.6.1/>`_
* `0.6 <https://pyepr.readthedocs.io/en/v0.6/>`_
License
......@@ -78,7 +79,7 @@ License
.. index:: license
Copyright (C) 2011-2015 Antonio Valentino <antonio.valentino@tiscali.it>
Copyright (C) 2011-2018 Antonio Valentino <antonio.valentino@tiscali.it>
PyEPR is free software: you can redistribute it and/or modify
it under the terms of the `GNU General Public License`_ as published by
......
doc/interactive_use.txt
View file @ da72fb9c
......@@ -3,16 +3,16 @@ Interactive use of PyEPR_
.. highlight:: ipython
.. index:: ipython, interactive, ENVISAT, ASAR, ESA, pylab, matplotlib
.. index:: jupyter, ipython, interactive, ENVISAT, ASAR, ESA, pylab, matplotlib
pair: interactive; shell
pair: sample; dataset
In this tutorial it is showed an example of how to use PyEPR_ interactively
to open, browse and display data of an ENVISAT_ ASAR_ product.
For the interactive session it is used the IPython_ interactive shell an
started with the :option:`ipython -pylab` option to enable interactive
plotting provided by the matplotlib_ package.
For the interactive session it is used the Jupyter_ console started
with the `--pylab` option to enable the interactive plotting features provided
by the matplotlib_ package.
The ASAR_ product used in this example is a `free sample`_ available at the
ESA_ web site.
......@@ -20,8 +20,8 @@ ESA_ web site.
.. _PyEPR: https://github.com/avalentino/pyepr
.. _ENVISAT: https://envisat.esa.int
.. _ASAR: https://earth.esa.int/handbooks/asar/CNTR.html
.. _IPython: http://ipython.org
.. _matplotlib: http://matplotlib.org
.. _Jupyter: http://jupyter.org/
.. _matplotlib: https://matplotlib.org
.. _`free sample`: https://earth.esa.int/services/sample_products/asar/IMP/ASA_IMP_1PNUPA20060202_062233_000000152044_00435_20529_3110.N1.gz
.. _ESA: https://earth.esa.int
......@@ -32,26 +32,25 @@ ESA_ web site.
:mod:`epr` module and classes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
After starting the ipython shell with the following command:
After starting the jupyter console with the following command:
.. code-block:: sh
$ ipython -pylab
$ jupyter console -- --pylab
one can import the :mod:`epr` module and start start taking confidence with
available classes and functions::
Python 2.6.6 (r266:84292, Sep 15 2010, 16:22:56)
Jupyter console 5.2.0
Python 3.6.5 (default, Apr 1 2018, 05:46:30)
Type "copyright", "credits" or "license" for more information.
IPython 0.10 -- An enhanced Interactive Python.
IPython 5.5.0 -- An enhanced Interactive Python.
? -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help -> Python's own help system.
object? -> Details about 'object'. ?object also works, ?? prints more.
Welcome to pylab, a matplotlib-based Python environment.
For more information, type 'help(pylab)'.
object? -> Details about 'object', use 'object??' for extra details.
In [1]: import epr
......@@ -88,11 +87,11 @@ available classes and functions::
Docstrings are available for almost all classes, methods and functions in
the :mod:`epr` and they can be displayed using the :func:`help` python_
command or the ``?`` IPython_ shortcut as showed above.
command or the ``?`` Jupyter_ shortcut as showed above.
.. _python: https://www.python.org
Also IPython_ provides a handy tab completion mechanism to automatically
Also Jupyter_ provides a handy tab completion mechanism to automatically
complete commands or to display available functions and classes::
In [4]: product = epr. [TAB]
......@@ -314,7 +313,7 @@ Dealing with image data is simple as well::
Image data read from the "proc_data" band
.. _iterable: http://docs.python.org/glossary.html#term-iterable
.. _iterable: https://docs.python.org/3/glossary.html#term-iterable
.. index:: close, product
......
doc/make.bat
View file @ da72fb9c
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
set I18NSPHINXOPTS=%SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
set SPHINXPROJ=PyEPR
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an epub
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. xml to make Docutils-native XML files
echo. pseudoxml to make pseudoxml-XML files for display purposes
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
%SPHINXBUILD% 2> nul
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
......@@ -60,183 +26,11 @@ if errorlevel 9009 (
exit /b 1
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\PyEPR.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PyEPR.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdf" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdfja" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf-ja
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "texinfo" (
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
goto end
)
if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
if "%1" == "xml" (
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The XML files are in %BUILDDIR%/xml.
goto end
)
if "%1" == "pseudoxml" (
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
goto end
)
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
:end
popd
doc/reference.txt
View file @ da72fb9c
This diff is collapsed.
doc/update_example.txt
View file @ da72fb9c
......@@ -186,7 +186,7 @@ The complete code of the example can be found at
.. _PyEPR: https://github.com/avalentino/pyepr
.. _ENVISAT: https://envisat.esa.int
.. _Matplotlib: http://matplotlib.org
.. _Matplotlib: https://matplotlib.org
.. raw:: latex
......
doc/usermanual.txt
View file @ da72fb9c
......@@ -65,7 +65,7 @@ correctly installed and configured:
* Python2_ >= 2.6 or Python3_ >= 3.1
* numpy_ >= 1.5.0
* `EPR API`_ >= 2.2 (optional, since PyEPR 0.7 the source tar-ball comes
with a copy of the PER C API sources)
with a copy of the EPR C API sources)
* a reasonably updated C compiler [#]_ (build only)
* Cython_ >= 0.19 [#]_ (optional and build only)
* unittest2_ (only required for Python < 2.7)
......@@ -84,7 +84,7 @@ correctly installed and configured:
.. _numpy: http://www.numpy.org
.. _gcc: http://gcc.gnu.org
.. _Cython: http://cython.org
.. _unittest2: https://pypi.python.org/pypi/unittest2
.. _unittest2: https://pypi.org/project/unittest2
.. index:: download, PyPi, GitHub, project, git
......@@ -97,7 +97,7 @@ Download
Official source tar-balls can be downloaded form PyPi_:
https://pypi.python.org/pypi/pyepr
https://pypi.org/project/pyepr
The source code of the development versions is available on the GitHub_
project page
......@@ -108,9 +108,9 @@ To clone the git_ repository the following command can be used::
$ git clone https://github.com/avalentino/pyepr.git
.. _PyPi: https://pypi.python.org/pypi
.. _PyPi: https://pypi.org
.. _GitHub: https://github.com
.. _git: http://git-scm.com
.. _git: https://git-scm.com
.. index:: install, pip
......@@ -162,7 +162,7 @@ In this case it is assumed that the `EPR API`_ C library is properly
installed in the system (see the Requirements_ section).
It is possible to control which `EPR API`_ C sources to use by means of the
:option:`--epr-api-src` option of the :file:`setup.py` script::
`--epr-api-src` option of the :file:`setup.py` script::
$ python setup.py install --epr-api-src=../epr-api/src
......@@ -171,7 +171,7 @@ with the system `EPR API`_ C library::
$ python setup.py install --epr-api-src=None
.. _pip: https://pypi.python.org/pypi/pip
.. _pip: https://pypi.org/project/pip
.. index:: test, setup.py, download
......@@ -224,7 +224,7 @@ API,
Of course there are also some differences that are illustrated in the
following sections.
.. _`C API`: https://rawgithub.com/bcdev/epr-api/master/docs/epr_c_api/index.html
.. _`C API`: https://rawgit.com/bcdev/epr-api/master/docs/epr_c_api/index.html
.. index:: memory, product
......
setup.py
View file @ da72fb9c
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (C) 2011-2015, Antonio Valentino <antonio.valentino@tiscali.it>
# Copyright (C) 2011-2018, Antonio Valentino <antonio.valentino@tiscali.it>
#
# This file is part of PyEPR.
#
......@@ -207,6 +207,9 @@ any data field contained in a product file.
'Programming Language :: Python :: 3.2',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: Implementation :: PyPy',
'Programming Language :: Cython',
'Topic :: Software Development :: Libraries',
'Topic :: Scientific/Engineering',
......