Skip to content
Snippets Groups Projects
Commit 5b3e3361 authored by jlaura's avatar jlaura Committed by Jason R Laura
Browse files

Documentation in for rtfd.

parent 5db0cb20
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 655 additions and 0 deletions
docs/_static/favicon.png 0 → 100644
+ 0
− 0
View file @ 5b3e3361
docs/_static/favicon.png

15.5 KiB

docs/_static/images/bugs.png 0 → 100644
+ 0
− 0
View file @ 5b3e3361
docs/_static/images/bugs.png

6.29 KiB

docs/_static/images/documentation.png 0 → 100644
+ 0
− 0
View file @ 5b3e3361
docs/_static/images/documentation.png

1.82 KiB

docs/_static/images/download.png 0 → 100644
+ 0
− 0
View file @ 5b3e3361
docs/_static/images/download.png

3.5 KiB

docs/_static/images/download2.png 0 → 100644
+ 0
− 0
View file @ 5b3e3361
docs/_static/images/download2.png

7.27 KiB

docs/_static/images/feed-icon.jpg 0 → 100644
+ 0
− 0
View file @ 5b3e3361
docs/_static/images/feed-icon.jpg

2.23 KiB

docs/_static/images/feed-icon.png 0 → 100644
+ 0
− 0
View file @ 5b3e3361
docs/_static/images/feed-icon.png

2.71 KiB

docs/_static/images/matched.png 0 → 100644
+ 0
− 0
View file @ 5b3e3361
docs/_static/images/matched.png

368 KiB

docs/_static/images/tutorial.png 0 → 100644
+ 0
− 0
View file @ 5b3e3361
docs/_static/images/tutorial.png

6.95 KiB

docs/_static/images/yi_jing_01_chien.jpg 0 → 100644
+ 0
− 0
View file @ 5b3e3361
docs/_static/images/yi_jing_01_chien.jpg

9.28 KiB

docs/_static/mydoc.css 0 → 100644
+ 3
− 0
View file @ 5b3e3361
@import url("default.css");
span.strike {text-decoration: line-through; }
docs/_templates/ganalytics_layout.html 0 → 100644
+ 213
− 0
View file @ 5b3e3361
{%- block doctype -%}
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
{%- endblock %}
{%- set reldelim1 = reldelim1 is not defined and ' &raquo;' or reldelim1 %}
{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
{%- macro relbar() %}
<div class="related">
<h3>{{ _('Navigation') }}</h3>
<ul>
{%- for rellink in rellinks %}
<li class="right" {% if loop.first %}style="margin-right: 10px"{% endif %}>
<a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags }}"
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
{%- if not loop.first %}{{ reldelim2 }}{% endif %}</li>
{%- endfor %}
{%- block rootrellink %}
<li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>
{%- endblock %}
{%- for parent in parents %}
<li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li>
{%- endfor %}
{%- block relbaritems %} {% endblock %}
</ul>
</div>
{%- endmacro %}
{%- macro sidebar() %}
{%- if not embedded %}{% if not theme_nosidebar|tobool %}
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
{%- block sidebarlogo %}
{%- if logo %}
<p class="logo"><a href="{{ pathto(master_doc) }}">
<img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
</a></p>
{%- endif %}
{%- endblock %}
{%- block sidebartoc %}
{%- if display_toc %}
<h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
{{ toc }}
{%- endif %}
{%- endblock %}
{%- block sidebarrel %}
{%- if prev %}
<h4>{{ _('Previous topic') }}</h4>
<p class="topless"><a href="{{ prev.link|e }}"
title="{{ _('previous chapter') }}">{{ prev.title }}</a></p>
{%- endif %}
{%- if next %}
<h4>{{ _('Next topic') }}</h4>
<p class="topless"><a href="{{ next.link|e }}"
title="{{ _('next chapter') }}">{{ next.title }}</a></p>
{%- endif %}
{%- endblock %}
{%- block sidebarsourcelink %}
{%- if show_source and has_source and sourcename %}
<h3>{{ _('This Page') }}</h3>
<ul class="this-page-menu">
<li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
rel="nofollow">{{ _('Show Source') }}</a></li>
</ul>
{%- endif %}
{%- endblock %}
{%- if customsidebar %}
{% include customsidebar %}
{%- endif %}
{%- block sidebarsearch %}
{%- if pagename != "search" %}
<div id="searchbox" style="display: none">
<h3>{{ _('Quick search') }}</h3>
<form class="search" action="{{ pathto('search') }}" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="{{ _('Go') }}" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
{{ _('Enter search terms or a module, class or function name.') }}
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
{%- endif %}
{%- endblock %}
</div>
</div>
{%- endif %}{% endif %}
{%- endmacro %}
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
{{ metatags }}
{%- if not embedded %}
{%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
{%- else %}
{%- set titlesuffix = "" %}
{%- endif %}
<title>{{ title|striptags }}{{ titlesuffix }}</title>
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
{%- if not embedded %}
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '{{ pathto("", 1) }}',
VERSION: '{{ release|e }}',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '{{ file_suffix }}',
HAS_SOURCE: {{ has_source|lower }}
};
</script>
{%- for scriptfile in script_files %}
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
{%- endfor %}
{%- if use_opensearch %}
<link rel="search" type="application/opensearchdescription+xml"
title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
href="{{ pathto('_static/opensearch.xml', 1) }}"/>
{%- endif %}
{%- if favicon %}
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
{%- endif %}
{%- endif %}
{%- block linktags %}
{%- if hasdoc('about') %}
<link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
{%- endif %}
{%- if hasdoc('genindex') %}
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
{%- endif %}
{%- if hasdoc('search') %}
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
{%- endif %}
{%- if hasdoc('copyright') %}
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
{%- endif %}
<link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
{%- if parents %}
<link rel="up" title="{{ parents[-1].title|striptags }}" href="{{ parents[-1].link|e }}" />
{%- endif %}
{%- if next %}
<link rel="next" title="{{ next.title|striptags }}" href="{{ next.link|e }}" />
{%- endif %}
{%- if prev %}
<link rel="prev" title="{{ prev.title|striptags }}" href="{{ prev.link|e }}" />
{%- endif %}
{%- endblock %}
{%- block extrahead %} {% endblock %}
</head>
<body>
{%- block header %}{% endblock %}
{%- block relbar1 %}{{ relbar() }}{% endblock %}
{%- block sidebar1 %} {# possible location for sidebar #} {% endblock %}
<div class="document">
{%- block document %}
<div class="documentwrapper">
{%- if not embedded %}{% if not theme_nosidebar|tobool %}
<div class="bodywrapper">
{%- endif %}{% endif %}
<div class="body">
{% block body %} {% endblock %}
</div>
{%- if not embedded %}{% if not theme_nosidebar|tobool %}
</div>
{%- endif %}{% endif %}
</div>
{%- endblock %}
{%- block sidebar2 %}{{ sidebar() }}{% endblock %}
<div class="clearer"></div>
</div>
{%- block relbar2 %}{{ relbar() }}{% endblock %}
{%- block footer %}
<div class="footer">
{%- if hasdoc('copyright') %}
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
{%- else %}
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
{%- endif %}
{%- if last_updated %}
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
{%- endif %}
{%- if show_sphinx %}
{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
{%- endif %}
</div>
{%- endblock %}
<!--Begin Google Analytics Code -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', '']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<!--End Google Analytics Code -->
</body>
</html>
docs/_templates/layout.html 0 → 100644
+ 19
− 0
View file @ 5b3e3361
{% extends "ganalytics_layout.html" %}
{% block rootrellink %}
<li><a href="{{ pathto('index') }}">home</a>|&nbsp;</li>
<li><a href="{{ pathto('search') }}">search</a>|&nbsp;</li>
<li><a href="{{ pathto('contents') }}">documentation </a> &raquo;</li>
{% endblock %}
{% block relbar1 %}
{{ super() }}
{% endblock %}
{# put the sidebar before the body #}
{% block sidebar1 %}{% endblock %}
{% block sidebar2 %}{{ sidebar() }}{% endblock %}
docs/conf.py 0 → 100755
+ 293
− 0
View file @ 5b3e3361
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# autocnet documentation build configuration file, created by
# sphinx-quickstart on Tue Jul 9 22:26:36 2013.
#
# 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.
import sys
import os
from unittest.mock import MagicMock
autodoc_mock_imports = ['proj4', 'gdal', 'osr','ogr', 'osgeo', 'osgeo.gdal',
'osgeo.gdalconst']
'''
class Mock(MagicMock):
@classmethod
def __getattr__(cls, name):
return Mock()
MOCK_MODULES = ['proj4', 'gdal', 'osr','ogr', 'cv2', 'scikit-image', 'skimage', 'skimage.feature', 'sklearn', 'osgeo']
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
'''
# 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.
# sys.path.insert(0, os.path.abspath('.'))
# Get the project root dir, which is the parent dir of this
# Insert the project root dir as the first element in the PYTHONPATH.
# This lets us ensure that the source package is imported, and that its
# version is used.
sys.path.insert(0, os.path.abspath('../'))
import plio
# -- General configuration ---------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '1.3'
# 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.viewcode', 'sphinx.ext.napoleon']
# NumpyDoc Options
numpydoc_show_class_members = True
numpydoc_class_members_toctree = False
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Planetary I/O (plio)'
copyright = u'2016 - , Plio Developers'
# 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 = plio.__version__
# The full version, including alpha/beta/rc tags.
release = plio.__version__
# 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'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['build']
# 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 = False
# 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
# 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
# -- 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 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 = "Planetary I/O"
# A shorter title for the navigation bar. Default is the same as
# html_title.
html_short_title = "Plio"
# The name of an image file (relative to this directory) to place at the
# top of the sidebar.
html_logo = "favicon.png"
# 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']
# If not '', a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
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.
# html_sidebars = {}
# 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 = True
# 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
# Output file base name for HTML help builder.
htmlhelp_basename = 'pliodoc'
# -- Options for LaTeX output ------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index', 'plio.tex',
u'Plio Documentation',
u'Jay Laura', '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 = False
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# If false, no module index is generated.
# latex_domain_indices = True
# -- Options for manual page output ------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'plio',
u'Plio Documentation',
[u'Jay Laura'], 1)
]
# If true, show URL addresses after external links.
# man_show_urls = False
# -- 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 = [
('index', 'plio',
u'Plio Documentation',
u'Jay Laura',
'plio',
'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
docs/developers/index.rst 0 → 100644
+ 5
− 0
View file @ 5b3e3361
Developer Guide
===============
.. toctree::
:maxdepth: 1
docs/index.rst 0 → 100644
+ 76
− 0
View file @ 5b3e3361
.. autocnet documentation master file, created by
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Planetary I/O
=============
.. raw:: html
<div class="section" id="showcase">
<a href=""><img src="_static/images/.png" border="0" alt="An image about planets and I/O"/></a>
</div>
.. sidebar:: Releases
- `Development 0.1.0dev <http://github.com/USGS-Astrogeology/plio>`_
Planetary I/O (Plio) is an open source collection of my commonly used I/O functionality. Plio is licensed in `the public domain`.
.. _the public domain: license.html
.. toctree::
:maxdepth: 1
users/index
developers/index
library/index
.. raw:: html
<style type="text/css">
table.linktable {
margin: 10px;
margin-bottom: 20px;
margin-left:auto;
margin-right: auto;
}
table.icontable {
margin: 10px;
}
table.linktable td {
padding-left: 15px;
padding-right: 15px;
padding-bottom: 5px;
text-align: center;
}
</style>
<table class="linktable">
<tr>
<td>
<a href="users/installation.html">
<img alt="Download" src="_static/images/download2.png" title="Download" height="80" style="display: block; margin-left: auto; margin-right: auto;"></a> </td>
<td>
<a href="users/tutorials/index.html">
<img alt="Getting Started" src="_static/images/tutorial.png" title="Getting Started" height="80" style="display: block; margin-left: auto; margin-right: auto;"></a> </td>
<td>
<a href="library/index.html">
<img alt="Documentation" src="_static/images/documentation.png" title="Documentation" height="80" style="display: block; margin-left: auto; margin-right: auto;"></a> </td>
<td>
<a href="http://github.com/pysal/pysal/issues?state=open">
<img alt="Bug Report" src="_static/images/bugs.png" title="Bug Report" height="80" style="display: block; margin-left: auto; margin-right: auto;"></a> </td>
</tr>
<tr>
<td><strong><small><a href="users/installation.html">Install</a></small></strong></td>
<td><strong><small><a href="users/tutorials/index.html">Getting Started</a></small></strong></td>
<td><strong><small><a href="library/index.html">Documentation</a></small></strong></td>
<td><strong><small><a href="https://github.com/USGS-Astrogeology/autocnet/issues">Report Bugs</a></small></strong></td>
</tr>
</table>
docs/library/date/index.rst 0 → 100644
+ 7
− 0
View file @ 5b3e3361
:mod:`date` --- DateTime Transformation
=======================================
.. toctree::
julian2ls
julian2season
\ No newline at end of file
docs/library/date/julian2ls.rst 0 → 100644
+ 10
− 0
View file @ 5b3e3361
:mod:`date.julian2ls` --- Conversion from Julian to LsubS
=========================================================
The :mod:`date.julian2ls` module provides functionality for the conversion between Julian date and LsubS
.. versionadded:: 0.1.0
.. automodule:: plio.date.julian2ls
:synopsis: Julian <-> LsubS conversion functionality
:members:
\ No newline at end of file
docs/library/date/julian2season.rst 0 → 100644
+ 10
− 0
View file @ 5b3e3361
:mod:`date.julian2season` --- Conversion from Julian to Mars Season
====================================================================
The :mod:`date.julian2season` module provides functionality for the conversion between Julian date and Martian season
.. versionadded:: 0.1.0
.. automodule:: plio.date.julian2season
:synopsis: Julian <-> Mars season conversion functionality
:members:
\ No newline at end of file
docs/library/index.rst 0 → 100644
+ 19
− 0
View file @ 5b3e3361
#################
Library Reference
#################
:Release: |version|
:Date: |today|
AutoCNet
========
Sub-packages
------------
.. toctree::
:maxdepth: 1
date/index
io/index
utils/index
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment