thermokarst/akextract
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Renamed to 'AKExtract'

Browse source
This commit is contained in:
Matthew Dillon (diogenes) 2013-09-16 20:37:44 -08:00
parent 3ea2ff162b
commit 64b45a2f8d
7 changed files with 27 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/Makefile
View file

@ -77,17 +77,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SNAPIndices.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/AKExtract.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SNAPIndices.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/AKExtract.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/SNAPIndices"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SNAPIndices"
@echo "# mkdir -p $$HOME/.local/share/devhelp/AKExtract"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/AKExtract"
@echo "# devhelp"
epub:

14
docs/conf.py
View file

@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# SNAPIndices documentation build configuration file, created by
# AKExtract documentation build configuration file, created by
# sphinx-quickstart on Thu Mar 28 16:33:50 2013.
#
# This file is execfile()d with the current directory set to its containing dir.
@ -40,7 +40,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'SNAPIndices'
project = u'AKExtract'
copyright = u'2013, Matthew Ryan Dillon'
# The version info for the project you're documenting, acts as replacement for
@ -164,7 +164,7 @@ html_last_updated_fmt = '%b %d, %Y'
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'SNAPIndicesdoc'
htmlhelp_basename = 'AKExtractdoc'
# -- Options for LaTeX output --------------------------------------------------
@ -183,7 +183,7 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'SNAPIndices.tex', u'SNAPIndices Documentation and Source',
('index', 'AKExtract.tex', u'AKExtract Documentation and Source',
u'Matthew Ryan Dillon', 'manual'),
]
@ -213,7 +213,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'snapindices', u'SNAPIndices Documentation',
('index', 'akextract', u'AKExtract Documentation',
[u'Matthew Ryan Dillon'], 1)
]
@ -227,8 +227,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'SNAPIndices', u'SNAPIndices Documentation',
u'Matthew Ryan Dillon', 'SNAPIndices', 'One line description of project.',
('index', 'AKExtract', u'AKExtract Documentation',
u'Matthew Ryan Dillon', 'AKExtract', 'One line description of project.',
'Miscellaneous'),
]

16
docs/index.rst
View file

@ -1,31 +1,31 @@
************************************
SNAPExtract Documentation and Source
************************************
**********************************
AKExtract Documentation and Source
**********************************
.. toctree::
:maxdepth: 4
.. default-domain:: python
.. automodule:: snapextract
.. automodule:: akextract
SNAPExtract is a Python project, currently supported under version
AKExtract is a Python project, currently supported under version
2.7.x and 3.3.x.
Requirements: gdal, numpy
Option: nose (for testing), sphinx (for docs)
Module: snapextract.backend
Module: akextract.backend
---------------------------
Automatic API Documentation.
.. automodule:: snapextract.backend
.. automodule:: akextract.backend
:members: SNAPDataSet, GeoRefData
Source: backend.py
^^^^^^^^^^^^^^^^^^
.. literalinclude:: ../snapextract/_backend.py
.. literalinclude:: ../akextract/_backend.py
Tests
-----