Kaydet (Commit) 2a17f64f authored tarafından Patrick Maupin's avatar Patrick Maupin

Modify index.rst for better github display

üst cdc2c2c4
...@@ -15,6 +15,14 @@ astor -- AST observe/rewrite ...@@ -15,6 +15,14 @@ astor -- AST observe/rewrite
astor is designed to allow easy manipulation of Python source via the AST. astor is designed to allow easy manipulation of Python source via the AST.
.. github display
This file was designed to be viewed at readthedocs_. Some
content will not display properly when viewing using the
github browser.
.. _readthedocs: http://astor.readthedocs.io/en/latest/
Getting Started Getting Started
--------------- ---------------
...@@ -65,12 +73,20 @@ areas: ...@@ -65,12 +73,20 @@ areas:
Classes Classes
--------- ---------
.. github display
**class CodeToAst**
.. class:: CodeToAst .. class:: CodeToAst
This is the base class for the helper function code_to_ast. This is the base class for the helper function code_to_ast.
It may be subclassed, but probably will not need to be. It may be subclassed, but probably will not need to be.
.. github display
**class TreeWalk**
.. class:: TreeWalk(node=None) .. class:: TreeWalk(node=None)
The TreeWalk class is designed to be subclassed in order The TreeWalk class is designed to be subclassed in order
...@@ -79,6 +95,10 @@ Classes ...@@ -79,6 +95,10 @@ Classes
at present :( at present :(
.. github display
**class ExplicitNodeVisitor**
.. class:: ExplicitNodeVisitor .. class:: ExplicitNodeVisitor
The ExplicitNodeVisitor class subclasses the ast.NodeVisitor The ExplicitNodeVisitor class subclasses the ast.NodeVisitor
...@@ -212,7 +232,7 @@ Command line utilities ...@@ -212,7 +232,7 @@ Command line utilities
-------------------------- --------------------------
rtrip rtrip
'''''' ~~~~~
There is currently one command-line utility:: There is currently one command-line utility::
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment