issue #22 - can't do dynamic generation or sphinx-apidoc on RTD, need…

… to commit this to repo until readthedocs/readthedocs.org#1083 is done
jantman · Jun 13, 2015 · 125b0d0 · 125b0d0
1 parent 1b0f4d2
commit 125b0d0
Show file tree

Hide file tree

Showing 13 changed files with 216 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -53,10 +53,6 @@ coverage.xml
 
 # Sphinx documentation
 docs/build/
-docs/source/awslimitchecker*.rst
-docs/source/modules.rst
-docs/source/limits.rst
-docs/source/iam_policy.rst
 
 # PyBuilder
 target/

diff --git a/docs/source/awslimitchecker.checker.rst b/docs/source/awslimitchecker.checker.rst
@@ -0,0 +1,7 @@
+awslimitchecker.checker module
+==============================
+
+.. automodule:: awslimitchecker.checker
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/awslimitchecker.limit.rst b/docs/source/awslimitchecker.limit.rst
@@ -0,0 +1,7 @@
+awslimitchecker.limit module
+============================
+
+.. automodule:: awslimitchecker.limit
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/awslimitchecker.rst b/docs/source/awslimitchecker.rst
@@ -0,0 +1,25 @@
+awslimitchecker package
+=======================
+
+.. automodule:: awslimitchecker
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    awslimitchecker.services
+
+Submodules
+----------
+
+.. toctree::
+
+   awslimitchecker.checker
+   awslimitchecker.limit
+   awslimitchecker.runner
+   awslimitchecker.version
+
diff --git a/docs/source/awslimitchecker.runner.rst b/docs/source/awslimitchecker.runner.rst
@@ -0,0 +1,7 @@
+awslimitchecker.runner module
+=============================
+
+.. automodule:: awslimitchecker.runner
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/awslimitchecker.services.base.rst b/docs/source/awslimitchecker.services.base.rst
@@ -0,0 +1,7 @@
+awslimitchecker.services.base module
+====================================
+
+.. automodule:: awslimitchecker.services.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/awslimitchecker.services.ec2.rst b/docs/source/awslimitchecker.services.ec2.rst
@@ -0,0 +1,7 @@
+awslimitchecker.services.ec2 module
+===================================
+
+.. automodule:: awslimitchecker.services.ec2
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/awslimitchecker.services.rst b/docs/source/awslimitchecker.services.rst
@@ -0,0 +1,16 @@
+awslimitchecker.services package
+================================
+
+.. automodule:: awslimitchecker.services
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   awslimitchecker.services.base
+   awslimitchecker.services.ec2
+
diff --git a/docs/source/awslimitchecker.services.vpc.rst b/docs/source/awslimitchecker.services.vpc.rst
@@ -0,0 +1,7 @@
+awslimitchecker.services.vpc module
+===================================
+
+.. automodule:: awslimitchecker.services.vpc
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/awslimitchecker.version.rst b/docs/source/awslimitchecker.version.rst
@@ -0,0 +1,7 @@
+awslimitchecker.version module
+==============================
+
+.. automodule:: awslimitchecker.version
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/iam_policy.rst b/docs/source/iam_policy.rst
@@ -0,0 +1,27 @@
+
+.. _iam_policy:
+
+Required IAM Permissions
+========================
+
+Below is the sample IAM policy from this version of awslimitchecker, listing the IAM
+permissions required for it to function correctly:
+
+.. code-block:: json
+
+    {
+      "Statement": [
+        {
+          "Action": [
+            "ec2:DescribeInstances", 
+            "ec2:DescribeReservedInstances", 
+            "ec2:DescribeSecurityGroups", 
+            "ec2:DescribeVolumes"
+          ], 
+          "Effect": "Allow", 
+          "Resource": "*"
+        }
+      ], 
+      "Version": "2012-10-17"
+    }
+
diff --git a/docs/source/limits.rst b/docs/source/limits.rst
@@ -0,0 +1,92 @@
+
+.. _limits:
+
+Supported Limits
+================
+
+.. _limits.trusted_advisor:
+
+Trusted Advisor Data
+---------------------
+
+TODO
+
+.. _limits.checks:
+
+Current Checks
+---------------
+
+The section below lists every limit that this version of awslimitchecker knows
+how to check, and its hard-coded default value (per AWS documentation).
+
+EC2
+++++
+
+================================================= =====
+Limit                                             Default
+================================================= =====
+EC2-Classic Elastic IPs                           5    
+EC2-VPC Elastic IPs                               5    
+General Purpose (SSD) volume storage (TiB)        20   
+Magnetic volume storage (TiB)                     20   
+Provisioned IOPS                                  40000
+Provisioned IOPS (SSD) volume storage (TiB)       20   
+Rules per VPC security group                      50   
+Running On-Demand EC2 instances                   20   
+Running On-Demand c1.medium instances             20   
+Running On-Demand c1.xlarge instances             20   
+Running On-Demand c3.2xlarge instances            20   
+Running On-Demand c3.4xlarge instances            20   
+Running On-Demand c3.8xlarge instances            20   
+Running On-Demand c3.large instances              20   
+Running On-Demand c3.xlarge instances             20   
+Running On-Demand c4.2xlarge instances            20   
+Running On-Demand c4.4xlarge instances            10   
+Running On-Demand c4.8xlarge instances            5    
+Running On-Demand c4.large instances              20   
+Running On-Demand c4.xlarge instances             20   
+Running On-Demand cc2.8xlarge instances           20   
+Running On-Demand cg1.4xlarge instances           2    
+Running On-Demand cr1.8xlarge instances           2    
+Running On-Demand d2.2xlarge instances            20   
+Running On-Demand d2.4xlarge instances            10   
+Running On-Demand d2.8xlarge instances            5    
+Running On-Demand d2.xlarge instances             20   
+Running On-Demand g2.2xlarge instances            5    
+Running On-Demand g2.8xlarge instances            2    
+Running On-Demand hi1.4xlarge instances           2    
+Running On-Demand hs1.8xlarge instances           2    
+Running On-Demand i2.2xlarge instances            8    
+Running On-Demand i2.4xlarge instances            4    
+Running On-Demand i2.8xlarge instances            2    
+Running On-Demand i2.xlarge instances             8    
+Running On-Demand m1.large instances              20   
+Running On-Demand m1.medium instances             20   
+Running On-Demand m1.small instances              20   
+Running On-Demand m1.xlarge instances             20   
+Running On-Demand m2.2xlarge instances            20   
+Running On-Demand m2.4xlarge instances            20   
+Running On-Demand m2.xlarge instances             20   
+Running On-Demand m3.2xlarge instances            20   
+Running On-Demand m3.large instances              20   
+Running On-Demand m3.medium instances             20   
+Running On-Demand m3.xlarge instances             20   
+Running On-Demand m4.2xlarge instances            20   
+Running On-Demand m4.4xlarge instances            20   
+Running On-Demand m4.8xlarge instances            20   
+Running On-Demand m4.large instances              20   
+Running On-Demand m4.xlarge instances             20   
+Running On-Demand r3.2xlarge instances            20   
+Running On-Demand r3.4xlarge instances            10   
+Running On-Demand r3.8xlarge instances            5    
+Running On-Demand r3.large instances              20   
+Running On-Demand r3.xlarge instances             20   
+Running On-Demand t1.micro instances              20   
+Running On-Demand t2.medium instances             20   
+Running On-Demand t2.micro instances              20   
+Running On-Demand t2.small instances              20   
+Security groups per VPC                           100  
+VPC security groups per elastic network interface 5    
+================================================= =====
+
+
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -0,0 +1,7 @@
+awslimitchecker
+===============
+
+.. toctree::
+   :maxdepth: 4
+
+   awslimitchecker