Added Second Example

DarioArzaba · Oct 18, 2019 · 2c45329 · 2c45329
1 parent 31570eb
commit 2c45329
Show file tree

Hide file tree

Showing 82 changed files with 18,251 additions and 0 deletions.
diff --git a/Example/Makefile b/Example/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = rst
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/Example/build/doctrees/Dogs.doctree b/Example/build/doctrees/Dogs.doctree
diff --git a/Example/build/doctrees/Pets.doctree b/Example/build/doctrees/Pets.doctree
diff --git a/Example/build/doctrees/environment.pickle b/Example/build/doctrees/environment.pickle
diff --git a/Example/build/doctrees/index.doctree b/Example/build/doctrees/index.doctree
diff --git a/Example/build/doctrees/modules.doctree b/Example/build/doctrees/modules.doctree
diff --git a/Example/build/html/.buildinfo b/Example/build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: a4356f6e2dfefb8ef1246867c30bdc33
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/Example/build/html/Dogs.html b/Example/build/html/Dogs.html
@@ -0,0 +1,256 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <title>Dogs module &mdash; Proyect Example Docs 1.0 documentation</title>
+
+
+
+
+
+
+
+
+  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
+
+
+      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
+        <script type="text/javascript" src="_static/jquery.js"></script>
+        <script type="text/javascript" src="_static/underscore.js"></script>
+        <script type="text/javascript" src="_static/doctools.js"></script>
+        <script type="text/javascript" src="_static/language_data.js"></script>
+
+    <script type="text/javascript" src="_static/js/theme.js"></script>
+
+
+
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="prev" title="Pets module" href="Pets.html" /> 
+</head>
+
+<body class="wy-body-for-nav">
+
+
+  <div class="wy-grid-for-nav">
+
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+            <a href="index.html" class="icon icon-home"> Proyect Example Docs
+
+
+
+          </a>
+
+
+
+
+
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="Pets.html">Pets module</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Dogs module</a></li>
+</ul>
+
+
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">Proyect Example Docs</a>
+
+      </nav>
+
+
+      <div class="wy-nav-content">
+
+        <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+
+      <li><a href="index.html">Docs</a> &raquo;</li>
+
+      <li>Dogs module</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+
+            <a href="_sources/Dogs.rst.txt" rel="nofollow"> View page source</a>
+
+
+      </li>
+
+  </ul>
+
+
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <div class="section" id="module-Dogs">
+<span id="dogs-module"></span><h1>Dogs module<a class="headerlink" href="#module-Dogs" title="Permalink to this headline">¶</a></h1>
+<p>Descripcion del documento 2</p>
+<dl class="class">
+<dt id="Dogs.Dogs">
+<em class="property">class </em><code class="sig-prename descclassname">Dogs.</code><code class="sig-name descname">Dogs</code><span class="sig-paren">(</span><em class="sig-param">name</em>, <em class="sig-param">owner</em><span class="sig-paren">)</span><a class="headerlink" href="#Dogs.Dogs" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Esta clase representa mascotas</p>
+<dl class="method">
+<dt id="Dogs.Dogs.add_pet">
+<code class="sig-name descname">add_pet</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#Dogs.Dogs.add_pet" title="Permalink to this definition">¶</a></dt>
+<dd><p>agrega una mascota a la lista</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>name</strong> (<em>string</em>) – nombre de la mascota para agregarla a la lista</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="method">
+<dt id="Dogs.Dogs.get_average_age">
+<em class="property">static </em><code class="sig-name descname">get_average_age</code><span class="sig-paren">(</span><em class="sig-param">pet_type</em><span class="sig-paren">)</span><a class="headerlink" href="#Dogs.Dogs.get_average_age" title="Permalink to this definition">¶</a></dt>
+<dd><p>Imprime la edad promedio de una mascota</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>pet_type</strong> (<em>string</em>) – Las 3 mascotas mas populares</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="method">
+<dt id="Dogs.Dogs.random_pets">
+<em class="property">classmethod </em><code class="sig-name descname">random_pets</code><span class="sig-paren">(</span><em class="sig-param">owner</em><span class="sig-paren">)</span><a class="headerlink" href="#Dogs.Dogs.random_pets" title="Permalink to this definition">¶</a></dt>
+<dd><p>Clase especial para generar un nombre al azar al crear una mascota.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>cls</strong> (<a class="reference internal" href="Pets.html#Pets.Pets" title="Pets.Pets"><em>Pets</em></a>) – instancia del constructor al azar se otorga a INIT.</p></li>
+<li><p><strong>owner</strong> (<em>string</em>) – nombre del dueno de la mascota</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="method">
+<dt id="Dogs.Dogs.show_pets">
+<code class="sig-name descname">show_pets</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Dogs.Dogs.show_pets" title="Permalink to this definition">¶</a></dt>
+<dd><p>imprime todas las mascotas actualmente en la lista</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="Dogs.Dogs.version">
+<code class="sig-name descname">version</code><em class="property"> = '0.1'</em><a class="headerlink" href="#Dogs.Dogs.version" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+
+
+           </div>
+
+          </div>
+          <footer>
+
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+
+        <a href="Pets.html" class="btn btn-neutral float-left" title="Pets module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+    </div>
+
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2019, Dario Arzaba
+
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+
+
+
+
+
+</body>
+</html>