Add plugin hooks to RTD documentation (#415)

Author: gnikonorov

docs/api_reference.rst

@@ -0,0 +1,12 @@
+API Reference
+-------------
+
+This is a reference to the plugin API.
+
+Hooks
+~~~~~
+
+This plugin exposes the following hooks:
+
+.. automodule:: pytest_html.hooks
+   :members:

docs/conf.py

@@ -8,9 +8,12 @@
 # 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('.'))
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../src/"))
+
+
 # -- Project information -----------------------------------------------------
 
 project = "pytest-html"
@@ -23,7 +26,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ["sphinx.ext.autodoc"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -54,3 +57,8 @@
 
 # The master toctree document.
 master_doc = "index"
+
+
+# -- Options for the autodoc extension ---------------------------------------
+
+autodoc_member_order = "alphabetical"

docs/index.rst

@@ -14,6 +14,7 @@ pytest-html is a plugin for `pytest`_ that generates a HTML report for test resu
 
    installing
    user_guide
+   api_reference
    development
 
 .. _pytest: http://pytest.org