From 76bd1a2d7139f923b62e82e5c2751bea61b50aa3 Mon Sep 17 00:00:00 2001 From: David Halter Date: Thu, 28 Feb 2013 23:19:17 +0430 Subject: [PATCH] add testing docs to sphinx --- docs/docs/development.rst | 3 +++ docs/docs/testing.rst | 21 +++++++++++++++++++++ docs/index.rst | 1 + 3 files changed, 25 insertions(+) create mode 100644 docs/docs/testing.rst diff --git a/docs/docs/development.rst b/docs/docs/development.rst index 90849f84..ffeaad22 100644 --- a/docs/docs/development.rst +++ b/docs/docs/development.rst @@ -33,6 +33,9 @@ In five chapters I'm trying to describe the internals of |jedi|: - :ref:`Caching & Recursions ` - :ref:`Helper modules ` +.. note:: Testing is not documented here, you'll find that + `here `_. + .. _core: diff --git a/docs/docs/testing.rst b/docs/docs/testing.rst new file mode 100644 index 00000000..5b126e90 --- /dev/null +++ b/docs/docs/testing.rst @@ -0,0 +1,21 @@ +.. include:: ../global.rst + +Jedi Testing +============ + +.. currentmodule:: test + +Blackbox Tests (run.py) +~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: run + +Regression Tests (regression.py) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: regression + +Refactoring Tests (refactor.py) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: refactor diff --git a/docs/index.rst b/docs/index.rst index 6f7c19fc..c8e518ea 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,6 +26,7 @@ Docs docs/plugin-api docs/history docs/development + docs/testing .. _resources: