basic documentation

docs/_static/css/custom.css

@@ -0,0 +1,9 @@
+@import url("theme.css");
+@import url("badge_only.css");
+.wy-nav-content {
+   max-width: 100% !important;
+}
+
+.wy-table-responsive table td, .wy-table-responsive table th {
+    white-space: pre-wrap;
+}

docs/apifuzzer/apifuzzer.base_template.rst

@@ -0,0 +1,7 @@
+apifuzzer\.base\_template module
+================================
+
+.. automodule:: apifuzzer.base_template
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/apifuzzer/apifuzzer.custom_fuzzers.rst

@@ -0,0 +1,7 @@
+apifuzzer\.custom\_fuzzers module
+=================================
+
+.. automodule:: apifuzzer.custom_fuzzers
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/apifuzzer/apifuzzer.fuzzer_target.rst

@@ -0,0 +1,7 @@
+apifuzzer\.fuzzer\_target module
+================================
+
+.. automodule:: apifuzzer.fuzzer_target
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/apifuzzer/apifuzzer.rst

@@ -0,0 +1,23 @@
+apifuzzer package
+=================
+
+Submodules
+----------
+
+.. toctree::
+
+   apifuzzer.base_template
+   apifuzzer.custom_fuzzers
+   apifuzzer.fuzzer_target
+   apifuzzer.server_fuzzer
+   apifuzzer.swagger_template_generator
+   apifuzzer.template_generator_base
+   apifuzzer.utils
+
+Module contents
+---------------
+
+.. automodule:: apifuzzer
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/apifuzzer/apifuzzer.server_fuzzer.rst

@@ -0,0 +1,7 @@
+apifuzzer\.server\_fuzzer module
+================================
+
+.. automodule:: apifuzzer.server_fuzzer
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/apifuzzer/apifuzzer.swagger_template_generator.rst

@@ -0,0 +1,7 @@
+apifuzzer\.swagger\_template\_generator module
+==============================================
+
+.. automodule:: apifuzzer.swagger_template_generator
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/apifuzzer/apifuzzer.template_generator_base.rst

@@ -0,0 +1,7 @@
+apifuzzer\.template\_generator\_base module
+===========================================
+
+.. automodule:: apifuzzer.template_generator_base
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/apifuzzer/apifuzzer.utils.rst

@@ -0,0 +1,7 @@
+apifuzzer\.utils module
+=======================
+
+.. automodule:: apifuzzer.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/apifuzzer/modules.rst

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

docs/conf.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+import os
+import sys
+
+path = os.path.abspath(os.path.join(os.path.dirname(os.path.realpath(__file__)), os.pardir))
+sys.path.insert(0, path)
+
+project_version = '0.9'
+project = project_version[0]
+version = "".join(project_version[1:])
+master_doc = "index"
+copyright = "All rights reserved"
+extensions = [
+    "sphinx.ext.autodoc",  # automatically include and render docstrings from code
+    "sphinx.ext.intersphinx",  # required to be able to link to Python standard documentation
+    "sphinx.ext.viewcode",  # add links to highlighted source code
+]
+
+# Required to be able to link to Python standard documentation
+intersphinx_mapping = {'python': ('https://docs.python.org/2', None)}
+
+# Exclude the given files from documentation generation
+exclude_patterns = [
+]
+
+primary_domain = 'py'
+default_role = 'py:obj'
+autodoc_member_order = "bysource"
+autoclass_content = "both"
+add_module_names = False
+html_show_sourcelink = False
+
+# Path to static files which will be copied over to html folder when building
+html_static_path = ['_static']
+
+# Without this line sphinx includes a copy of object.__init__'s docstring
+# on any class that doesn't define __init__.
+# https://bitbucket.org/birkenfeld/sphinx/issue/1337/autoclass_content-both-uses-object__init__
+autodoc_docstring_signature = False
+coverage_skip_undoc_in_source = True
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+# On RTD we can't import sphinx_rtd_theme, but it will be applied by
+# default anyway.  This block will use the same theme when building locally
+if not on_rtd:
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+    html_style = 'css/custom.css'