Skip to content

Commit

Permalink
Doc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
rocky committed Oct 1, 2017
1 parent 5ee7157 commit 03b52df
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 33 deletions.
16 changes: 0 additions & 16 deletions docs/overview.rst → docs/features.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,5 @@
|buildstatus| |appveyor| |license| |Supported Python Versions|

.. contents:: :local:

Abstract
========

This is a gdb-like debugger for Python. It is a rewrite of *pdb* from the ground up.

A command-line interface (CLI) is provided as well as an remote access
interface over TCP/IP.

See the Tutorial_ for how to use. See ipython-trepan_ for using this
in *ipython* or an *ipython notebook*.

This package is for Python 2.6 and 2.7. See trepan3k_ for the same code modified to work with Python 3.
For Python before 2.6, use pydbgr_ .

Features
========

Expand Down
20 changes: 17 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,27 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to trepan2's documentation!
==================================
trepan2 - a gdb-like debugger for Python 2
==========================================

trepan2 is a gdb-like debugger for Python. It is a rewrite of *pdb*
from the ground up.

A command-line interface (CLI) is provided as well as an remote access
interface over TCP/IP.

See the Tutorial_ for how to use. See ipython-trepan_ for using this
in *ipython* or an *ipython notebook*.

This package is for Python 2.6 and 2.7. See trepan3k_ for the same
code modified to work with Python 3. For Python before 2.6, use
pydbgr_ .


.. toctree::
:maxdepth: 2

overview
features
install
entry-exit
syntax
Expand Down
2 changes: 1 addition & 1 deletion docs/manpages/trepan2.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _trepan2:

trepan2 (Python2 debugger)
trepan2 - Python2 debugger
##########################

Synopsis
Expand Down
13 changes: 0 additions & 13 deletions src_obj_check.py

This file was deleted.

0 comments on commit 03b52df

Please sign in to comment.