Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/api_reference.rst
Original file line number Diff line number Diff line change
@@ -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:
16 changes: 12 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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/"))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ugh... isn't there a better way?

Maybe setting the PYTHONPATH env var?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not entirely sure @BeyondEvil. I made that change as per https://github.com/pytest-dev/pytest-html/blob/master/docs/conf.py#L7 and also some results on the internet. It seems like this is the preferred way to go about doing this

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough @gnikonorov

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you ok with me merging this in then @BeyondEvil?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well sure, on one condition. If you, once it's rebased and updated, approve the flaky windows PR. 😛 @gnikonorov



# -- Project information -----------------------------------------------------

project = "pytest-html"
Expand All @@ -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"]
Expand Down Expand Up @@ -54,3 +57,8 @@

# The master toctree document.
master_doc = "index"


# -- Options for the autodoc extension ---------------------------------------

autodoc_member_order = "alphabetical"
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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