Permalink
Browse files

Restructured folder

  • Loading branch information...
1 parent 6e985c3 commit f38891e9cc5b265ad264d2372cd1107841c61b9c @lavelle committed Apr 29, 2012
View
@@ -0,0 +1,134 @@
+%
+% API Documentation for API Documentation
+% Include File
+%
+% Generated by epydoc 3.0.1
+% [Thu Apr 26 18:39:20 2012]
+%
+\documentclass{article}
+\usepackage{alltt, parskip, fancyhdr, boxedminipage}
+\usepackage{makeidx, multirow, longtable, tocbibind, amssymb}
+\usepackage{fullpage}
+\usepackage[usenames]{color}
+\setlength{\headheight}{16pt}
+\setlength{\headsep}{24pt}
+\setlength{\topmargin}{-\headsep}
+\setlength{\parindent}{0ex}
+\setlength{\parskip}{2ex}
+\setlength{\fboxrule}{2\fboxrule}
+\newlength{\BCL} % base class length, for base trees.
+\pagestyle{fancy}
+\renewcommand{\sectionmark}[1]{\markboth{#1}{}}
+\renewcommand{\subsectionmark}[1]{\markright{#1}}
+\definecolor{py@keywordcolour}{rgb}{1,0.45882,0}
+\definecolor{py@stringcolour}{rgb}{0,0.666666,0}
+\definecolor{py@commentcolour}{rgb}{1,0,0}
+\definecolor{py@ps1colour}{rgb}{0.60784,0,0}
+\definecolor{py@ps2colour}{rgb}{0.60784,0,1}
+\definecolor{py@inputcolour}{rgb}{0,0,0}
+\definecolor{py@outputcolour}{rgb}{0,0,1}
+\definecolor{py@exceptcolour}{rgb}{1,0,0}
+\definecolor{py@defnamecolour}{rgb}{1,0.5,0.5}
+\definecolor{py@builtincolour}{rgb}{0.58039,0,0.58039}
+\definecolor{py@identifiercolour}{rgb}{0,0,0}
+\definecolor{py@linenumcolour}{rgb}{0.4,0.4,0.4}
+\definecolor{py@inputcolour}{rgb}{0,0,0}
+% Prompt
+\newcommand{\pysrcprompt}[1]{\textcolor{py@ps1colour}{\small\textbf{#1}}}
+\newcommand{\pysrcmore}[1]{\textcolor{py@ps2colour}{\small\textbf{#1}}}
+% Source code
+\newcommand{\pysrckeyword}[1]{\textcolor{py@keywordcolour}{\small\textbf{#1}}}
+\newcommand{\pysrcbuiltin}[1]{\textcolor{py@builtincolour}{\small\textbf{#1}}}
+\newcommand{\pysrcstring}[1]{\textcolor{py@stringcolour}{\small\textbf{#1}}}
+\newcommand{\pysrcdefname}[1]{\textcolor{py@defnamecolour}{\small\textbf{#1}}}
+\newcommand{\pysrcother}[1]{\small\textbf{#1}}
+% Comments
+\newcommand{\pysrccomment}[1]{\textcolor{py@commentcolour}{\small\textbf{#1}}}
+% Output
+\newcommand{\pysrcoutput}[1]{\textcolor{py@outputcolour}{\small\textbf{#1}}}
+% Exceptions
+\newcommand{\pysrcexcept}[1]{\textcolor{py@exceptcolour}{\small\textbf{#1}}}
+\newlength{\funcindent}
+\newlength{\funcwidth}
+\setlength{\funcindent}{1cm}
+\setlength{\funcwidth}{\textwidth}
+\addtolength{\funcwidth}{-2\funcindent}
+\newlength{\varindent}
+\newlength{\varnamewidth}
+\newlength{\vardescrwidth}
+\newlength{\varwidth}
+\setlength{\varindent}{1cm}
+\setlength{\varnamewidth}{.3\textwidth}
+\setlength{\varwidth}{\textwidth}
+\addtolength{\varwidth}{-4\tabcolsep}
+\addtolength{\varwidth}{-3\arrayrulewidth}
+\addtolength{\varwidth}{-2\varindent}
+\setlength{\vardescrwidth}{\varwidth}
+\addtolength{\vardescrwidth}{-\varnamewidth}
+\newenvironment{Ventry}[1]%
+ {\begin{list}{}{%
+ \renewcommand{\makelabel}[1]{\texttt{##1:}\hfil}%
+ \settowidth{\labelwidth}{\texttt{#1:}}%
+ \setlength{\leftmargin}{\labelsep}%
+ \addtolength{\leftmargin}{\labelwidth}}}%
+ {\end{list}}
+\usepackage[utf8]{inputenc}
+\definecolor{UrlColor}{rgb}{0,0.08,0.45}
+\usepackage[dvips, pagebackref, pdftitle={API Documentation}, pdfcreator={epydoc 3.0.1}, bookmarks=true, bookmarksopen=false, pdfpagemode=UseOutlines, colorlinks=true, linkcolor=black, anchorcolor=black, citecolor=black, filecolor=black, menucolor=black, pagecolor=black, urlcolor=UrlColor]{hyperref}
+\makeindex
+
+\begin{document}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Header %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Title %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\title{API~Documentation}
+\author{API Documentation}
+\maketitle
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Table of Contents %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\addtolength{\parskip}{-2ex}
+\tableofcontents
+\addtolength{\parskip}{2ex}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Includes %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\include{lib-module}
+\include{lib.clipboard-module}
+\include{lib.dropbox-module}
+\include{lib.gist-module}
+\include{lib.gridformat-module}
+\include{lib.history-module}
+\include{lib.main-module}
+\include{lib.message-module}
+\include{lib.oauth-module}
+\include{lib.pyjson-module}
+\include{lib.screenshot-module}
+\include{lib.settings-module}
+\include{lib.tray-module}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Index %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\printindex
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Footer %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\end{document}
+
View
@@ -0,0 +1,104 @@
+%
+% API Documentation for API Documentation
+% Module clipcloud
+%
+% Generated by epydoc 3.0.1
+% [Thu Apr 26 18:39:09 2012]
+%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Module Description %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+ \index{clipcloud \textit{(module)}|(}
+\section{Module clipcloud}
+
+ \label{clipcloud}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Functions %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+ \subsection{Functions}
+
+ \label{clipcloud:clipcloud}
+ \index{clipcloud \textit{(module)}!clipcloud.clipcloud \textit{(function)}}
+
+ \vspace{0.5ex}
+
+\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}
+
+ \raggedright \textbf{clipcloud}()
+
+ \vspace{-1.5ex}
+
+ \rule{\textwidth}{0.5\fboxrule}
+\setlength{\parskip}{2ex}
+ Wrapper around the rest of the program's functionality. Receives the
+ command line parameters and passes them on to be processed. Also does
+ some other stuff that needs to be done every time the program runs.
+
+\setlength{\parskip}{1ex}
+ \end{boxedminipage}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Variables %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+ \subsection{Variables}
+
+ \vspace{-1cm}
+\hspace{\varindent}\begin{longtable}{|p{\varnamewidth}|p{\vardescrwidth}|l}
+\cline{1-2}
+\cline{1-2} \centering \textbf{Name} & \centering \textbf{Description}& \\
+\cline{1-2}
+\endhead\cline{1-2}\multicolumn{3}{r}{\small\textit{continued on next page}}\\\endfoot\cline{1-2}
+\endlastfoot\raggedright A\-P\-P\-\_\-N\-A\-M\-E\- & \raggedright \textbf{Value:}
+{\tt \texttt{'}\texttt{ClipCloud}\texttt{'}}&\\
+\cline{1-2}
+\raggedright A\-P\-P\-\_\-P\-A\-T\-H\- & \raggedright \textbf{Value:}
+{\tt \texttt{'}\texttt{C:{\textbackslash}{\textbackslash}Users{\textbackslash}{\textbackslash}Giles{\textbackslash}{\textbackslash}AppData{\textbackslash}{\textbackslash}Roaming{\textbackslash}{\textbackslash}ClipCloud}\texttt{'}}&\\
+\cline{1-2}
+\raggedright D\-E\-B\-U\-G\- & \raggedright \textbf{Value:}
+{\tt True}&\\
+\cline{1-2}
+\raggedright G\-I\-T\-H\-U\-B\-\_\-T\-O\-K\-E\-N\-\_\-P\-A\-T\-H\- & \raggedright \textbf{Value:}
+{\tt \texttt{'}\texttt{C:{\textbackslash}{\textbackslash}Users{\textbackslash}{\textbackslash}Giles{\textbackslash}{\textbackslash}AppData{\textbackslash}{\textbackslash}Roaming{\textbackslash}{\textbackslash}ClipCloud{\textbackslash}{\textbackslash}github\_to}\texttt{...}}&\\
+\cline{1-2}
+\raggedright H\-E\-L\-P\-\_\-M\-E\-S\-S\-A\-G\-E\- & \raggedright \textbf{Value:}
+{\tt \texttt{'}\texttt{{\textbackslash}nClipCloud is a program for easily sharing all kinds of}\texttt{...}}&\\
+\cline{1-2}
+\raggedright H\-I\-S\-T\-O\-R\-Y\-\_\-P\-A\-T\-H\- & \raggedright \textbf{Value:}
+{\tt \texttt{'}\texttt{C:{\textbackslash}{\textbackslash}Users{\textbackslash}{\textbackslash}Giles{\textbackslash}{\textbackslash}AppData{\textbackslash}{\textbackslash}Roaming{\textbackslash}{\textbackslash}ClipCloud{\textbackslash}{\textbackslash}history.j}\texttt{...}}&\\
+\cline{1-2}
+\raggedright P\-L\-A\-T\-F\-O\-R\-M\- & \raggedright \textbf{Value:}
+{\tt \texttt{'}\texttt{Windows}\texttt{'}}&\\
+\cline{1-2}
+\raggedright S\-C\-R\-E\-E\-N\-S\-H\-O\-T\-\_\-P\-A\-T\-H\- & \raggedright \textbf{Value:}
+{\tt \texttt{'}\texttt{C:{\textbackslash}{\textbackslash}Users{\textbackslash}{\textbackslash}Giles{\textbackslash}{\textbackslash}AppData{\textbackslash}{\textbackslash}Roaming{\textbackslash}{\textbackslash}ClipCloud{\textbackslash}{\textbackslash}img}\texttt{'}}&\\
+\cline{1-2}
+\raggedright S\-H\-A\-R\-E\-\_\-M\-E\-S\-S\-A\-G\-E\- & \raggedright \textbf{Value:}
+{\tt \texttt{'}\texttt{I just uploaded a file to ClipCloud - check it out.}\texttt{'}}&\\
+\cline{1-2}
+\raggedright S\-H\-A\-R\-I\-N\-G\-\_\-S\-E\-R\-V\-I\-C\-E\-S\- & \raggedright \textbf{Value:}
+{\tt \texttt{[}\texttt{'}\texttt{clipboard}\texttt{'}\texttt{, }\texttt{'}\texttt{facebook}\texttt{'}\texttt{, }\texttt{'}\texttt{twitter}\texttt{'}\texttt{, }\texttt{'}\texttt{email}\texttt{'}\texttt{, }\texttt{'}\texttt{stdout}\texttt{'}\texttt{]}}&\\
+\cline{1-2}
+\raggedright T\-I\-M\-E\-R\-\_\-A\-C\-T\-I\-V\-A\-T\-E\-D\- & \raggedright \textbf{Value:}
+{\tt True}&\\
+\cline{1-2}
+\raggedright T\-M\-P\-\_\-P\-A\-T\-H\- & \raggedright \textbf{Value:}
+{\tt \texttt{'}\texttt{C:{\textbackslash}{\textbackslash}Users{\textbackslash}{\textbackslash}Giles{\textbackslash}{\textbackslash}AppData{\textbackslash}{\textbackslash}Roaming{\textbackslash}{\textbackslash}ClipCloud{\textbackslash}{\textbackslash}tmp}\texttt{'}}&\\
+\cline{1-2}
+\raggedright T\-O\-K\-E\-N\-\_\-P\-A\-T\-H\- & \raggedright \textbf{Value:}
+{\tt \texttt{'}\texttt{C:{\textbackslash}{\textbackslash}Users{\textbackslash}{\textbackslash}Giles{\textbackslash}{\textbackslash}AppData{\textbackslash}{\textbackslash}Roaming{\textbackslash}{\textbackslash}ClipCloud{\textbackslash}{\textbackslash}token.json}\texttt{'}}&\\
+\cline{1-2}
+\raggedright U\-R\-L\-S\- & \raggedright \textbf{Value:}
+{\tt \texttt{\{}\texttt{'}\texttt{email}\texttt{'}\texttt{: }\texttt{'}\texttt{mailto:?subject=\%s\&body=\%s}\texttt{'}\texttt{, }\texttt{'}\texttt{facebook}\texttt{'}\texttt{: }\texttt{'}\texttt{http}\texttt{...}}&\\
+\cline{1-2}
+\raggedright \_\-\_\-p\-a\-c\-k\-a\-g\-e\-\_\-\_\- & \raggedright \textbf{Value:}
+{\tt None}&\\
+\cline{1-2}
+\end{longtable}
+
+ \index{clipcloud \textit{(module)}|)}
View
@@ -0,0 +1,88 @@
+%
+% API Documentation for API Documentation
+% Package lib
+%
+% Generated by epydoc 3.0.1
+% [Thu Apr 26 18:39:20 2012]
+%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Module Description %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+ \index{lib \textit{(package)}|(}
+\section{Package lib}
+
+ \label{lib}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Modules %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsection{Modules}
+
+\begin{itemize}
+\setlength{\parskip}{0ex}
+\item \textbf{clipboard}
+ \textit{(Section \ref{lib:clipboard}, p.~\pageref{lib:clipboard})}
+
+\item \textbf{dropbox}: The Dropbox API and several methods to abstract common operations
+
+
+
+ \textit{(Section \ref{lib:dropbox}, p.~\pageref{lib:dropbox})}
+
+\item \textbf{gist}
+ \textit{(Section \ref{lib:gist}, p.~\pageref{lib:gist})}
+
+\item \textbf{gridformat}
+ \textit{(Section \ref{lib:gridformat}, p.~\pageref{lib:gridformat})}
+
+\item \textbf{history}
+ \textit{(Section \ref{lib:history}, p.~\pageref{lib:history})}
+
+\item \textbf{main}
+ \textit{(Section \ref{lib:main}, p.~\pageref{lib:main})}
+
+\item \textbf{message}
+ \textit{(Section \ref{lib:message}, p.~\pageref{lib:message})}
+
+\item \textbf{oauth}: The MIT License
+
+
+
+ \textit{(Section \ref{lib:oauth}, p.~\pageref{lib:oauth})}
+
+\item \textbf{pyjson}
+ \textit{(Section \ref{lib:pyjson}, p.~\pageref{lib:pyjson})}
+
+\item \textbf{screenshot}
+ \textit{(Section \ref{lib:screenshot}, p.~\pageref{lib:screenshot})}
+
+\item \textbf{settings}
+ \textit{(Section \ref{lib:settings}, p.~\pageref{lib:settings})}
+
+\item \textbf{tray}
+ \textit{(Section \ref{lib:tray}, p.~\pageref{lib:tray})}
+
+\end{itemize}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Variables %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+ \subsection{Variables}
+
+ \vspace{-1cm}
+\hspace{\varindent}\begin{longtable}{|p{\varnamewidth}|p{\vardescrwidth}|l}
+\cline{1-2}
+\cline{1-2} \centering \textbf{Name} & \centering \textbf{Description}& \\
+\cline{1-2}
+\endhead\cline{1-2}\multicolumn{3}{r}{\small\textit{continued on next page}}\\\endfoot\cline{1-2}
+\endlastfoot\raggedright \_\-\_\-p\-a\-c\-k\-a\-g\-e\-\_\-\_\- & \raggedright \textbf{Value:}
+{\tt None}&\\
+\cline{1-2}
+\end{longtable}
+
+ \index{lib \textit{(package)}|)}
Oops, something went wrong.

0 comments on commit f38891e

Please sign in to comment.