deploy: f1ce685

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 600c5c502475bd6f1c676f8132e4d91a
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/LICENSE.rst.txt

@@ -0,0 +1,5 @@
+===============================================================================
+BSD 3-Clause License
+===============================================================================
+
+.. include:: ../LICENSE.txt

_sources/autoapi/cheshire/_version/index.rst.txt

@@ -0,0 +1,40 @@
+cheshire._version
+=================
+
+.. py:module:: cheshire._version
+
+
+Attributes
+----------
+
+.. autoapisummary::
+
+   cheshire._version.TYPE_CHECKING
+   cheshire._version.VERSION_TUPLE
+   cheshire._version.version
+   cheshire._version.__version__
+   cheshire._version.__version_tuple__
+   cheshire._version.version_tuple
+
+
+Module Contents
+---------------
+
+.. py:data:: TYPE_CHECKING
+   :value: False
+
+
+.. py:data:: VERSION_TUPLE
+
+.. py:data:: version
+   :type:  str
+
+.. py:data:: __version__
+   :type:  str
+
+.. py:data:: __version_tuple__
+   :type:  VERSION_TUPLE
+
+.. py:data:: version_tuple
+   :type:  VERSION_TUPLE
+

_sources/autoapi/cheshire/cli/index.rst.txt

@@ -0,0 +1,51 @@
+cheshire.cli
+============
+
+.. py:module:: cheshire.cli
+
+.. autoapi-nested-parse::
+
+   A skeleton of a command line interface to be deployed as an entry point script.
+
+   It takes two numbers and does something to them, printing out the result.
+
+
+
+Attributes
+----------
+
+.. autoapisummary::
+
+   cheshire.cli.logger
+
+
+Functions
+---------
+
+.. autoapisummary::
+
+   cheshire.cli.parse_command_line
+   cheshire.cli.main
+
+
+Module Contents
+---------------
+
+.. py:data:: logger
+
+.. py:function:: parse_command_line(argv)
+
+   Parse command line arguments. See the -h option for details.
+
+   :param argv: Command line arguments, including caller filename.
+   :type argv: str
+
+   :returns: Dictionary of command line arguments and their parsed values.
+   :rtype: dict
+
+
+.. py:function:: main()
+
+   Demonstrate a really basic command line interface (CLI) that takes arguments.
+
+

_sources/autoapi/cheshire/dummy/index.rst.txt

@@ -0,0 +1,37 @@
+cheshire.dummy
+==============
+
+.. py:module:: cheshire.dummy
+
+.. autoapi-nested-parse::
+
+   A dummy module so coverage has something to cover.
+
+
+
+Attributes
+----------
+
+.. autoapisummary::
+
+   cheshire.dummy.logger
+
+
+Functions
+---------
+
+.. autoapisummary::
+
+   cheshire.dummy.do_something
+
+
+Module Contents
+---------------
+
+.. py:data:: logger
+
+.. py:function:: do_something(a = 0, b = 0)
+
+   A dummy function that does something.
+
+

_sources/autoapi/cheshire/dummy_pudl/index.rst.txt

@@ -0,0 +1,29 @@
+cheshire.dummy_pudl
+===================
+
+.. py:module:: cheshire.dummy_pudl
+
+.. autoapi-nested-parse::
+
+   Example of a module that contains functions for PUDL.
+
+
+
+Functions
+---------
+
+.. autoapisummary::
+
+   cheshire.dummy_pudl.use_a_table_from_pudl
+
+
+Module Contents
+---------------
+
+.. py:function:: use_a_table_from_pudl()
+
+   Use a table from the PUDL GCS bucket.
+
+   This is an example of a function that uses a table from PUDL.
+
+

_sources/autoapi/cheshire/index.rst.txt

@@ -0,0 +1,106 @@
+cheshire
+========
+
+.. py:module:: cheshire
+
+.. autoapi-nested-parse::
+
+   A template repository for a Python package.
+
+   Created by Catalyst Cooperative, modified by RMI.
+
+
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   /autoapi/cheshire/_version/index
+   /autoapi/cheshire/cli/index
+   /autoapi/cheshire/dummy/index
+   /autoapi/cheshire/dummy_pudl/index
+
+
+Attributes
+----------
+
+.. autoapisummary::
+
+   cheshire.logger
+   cheshire.__author__
+   cheshire.__contact__
+   cheshire.__maintainer__
+   cheshire.__license__
+   cheshire.__maintainer_email__
+   cheshire.__docformat__
+   cheshire.__description__
+   cheshire.__long_description__
+   cheshire.__version__
+   cheshire.__projecturl__
+   cheshire.__downloadurl__
+
+
+Package Contents
+----------------
+
+.. py:data:: logger
+
+.. py:data:: __author__
+   :value: 'RMI'
+
+
+.. py:data:: __contact__
+   :value: '[email protected]'
+
+
+.. py:data:: __maintainer__
+   :value: 'Cheshire Cat'
+
+
+.. py:data:: __license__
+   :value: 'BSD 3-Clause License'
+
+
+.. py:data:: __maintainer_email__
+   :value: '[email protected]'
+
+
+.. py:data:: __docformat__
+   :value: 'restructuredtext en'
+
+
+.. py:data:: __description__
+   :value: 'A template for Python package repositories.'
+
+
+.. py:data:: __long_description__
+   :value: Multiline-String
+
+   .. raw:: html
+
+      <details><summary>Show Value</summary>
+
+   .. code-block:: python
+
+      """
+      This should be a paragraph long description of what the package does.
+      """
+
+   .. raw:: html
+
+      </details>
+
+
+
+.. py:data:: __version__
+
+.. py:data:: __projecturl__
+   :value: 'https://github.com/rmi-electricity/cheshire'
+
+
+.. py:data:: __downloadurl__
+   :value: 'https://github.com/rmi-electricity/cheshire'
+
+

_sources/autoapi/index.rst.txt

@@ -0,0 +1,11 @@
+API Reference
+=============
+
+This page contains auto-generated API reference documentation [#f1]_.
+
+.. toctree::
+   :titlesonly:
+
+   /autoapi/cheshire/index
+
+.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_