Updates for RTD

Author: vesche

.gitignore

@@ -2,3 +2,4 @@
 *.egg-info/
 dist/
 build/
+staging/

docketapi/__init__.py

@@ -1,3 +1,5 @@
+"""docketapi"""
+
 import json
 import requests
 
@@ -13,14 +15,14 @@ class DocketClient:
     Core class used for interacting with the Docket RESTful API.
 
     Args:
-        base_url (str): URL pointing to Docket instance
+        base_url (str): URL pointing to the ROCK NSM (or Docket) instance
         username (str): Authentication username
         password (str): Authentication password
         verify (bool): Verify SSL (ignored on HTTP). Disable to use self-signed certificates
         proxies (dict): Optional requests-style proxies dict
 
     Attributes:
-        base_url (str): Full RFC-1738 URL pointing to Docket instance
+        base_url (str): Full RFC-1738 URL pointing to the ROCK NSM (or Docket) instance
         query_url (str): URL pointing to Docket query endpoint
         username (str): Authentication username
         session (requests.sessions.Session): Requests session used for all outbound requests
@@ -71,7 +73,7 @@ def __repr__(self):
         )
 
     def _get(self, uri):
-        """GET request for retrieving PCAP.
+        """GET request for retrieving PCAP
 
         Args:
             uri (str): URI to GET, this will be the PCAP endpoint
@@ -81,7 +83,7 @@ def _get(self, uri):
         return r.content
 
     def _post(self, data):
-        """POST request for performing queries.
+        """POST request for performing queries
 
         Args:
             data (dict): JSON payload query data to POST

docs/_static/.keep

@@ -0,0 +1,177 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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('../docketapi'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = u'docket-python-client'
+copyright = u'2019, Austin Jackson'
+author = u'Austin Jackson'
+
+# The short X.Y version
+version = u''
+# The full version, including alpha/beta/rc tags
+release = u'0.0.1'
+
+
+# -- 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
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# 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.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 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'
+
+# 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 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'docket-python-clientdoc'
+
+
+# -- 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': '',
+
+    # 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 = [
+    (master_doc, 'docket-python-client.tex', u'docket-python-client Documentation',
+     u'Austin Jackson', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'docket-python-client', u'docket-python-client Documentation',
+     [author], 1)
+]
+
+
+# -- 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 = [
+    (master_doc, 'docket-python-client', u'docket-python-client Documentation',
+     author, 'docket-python-client', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# 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 list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------

docs/conf.py

@@ -0,0 +1,10 @@
+docketapi package
+=================
+
+Module contents
+---------------
+
+.. automodule:: docketapi
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/docketapi.rst

@@ -0,0 +1,2 @@
+*
+!.gitignore

docs/html/.gitignore

@@ -0,0 +1,7 @@
+docketapi
+=========
+
+.. toctree::
+   Modules <modules.rst> 
+   :maxdepth: 4
+

docs/index.rst

@@ -0,0 +1,7 @@
+docketapi
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   docketapi