Update doc

README.md

@@ -1,3 +1,7 @@
+README
+======
+
+
 [![Build Status](https://travis-ci.org/MISP/PyMISP.svg?branch=master)](https://travis-ci.org/MISP/PyMISP)
 [![Coverage Status](https://coveralls.io/repos/github/MISP/PyMISP/badge.svg?branch=master)](https://coveralls.io/github/MISP/PyMISP?branch=master)
 
@@ -12,16 +16,17 @@ PyMISP allows you to fetch events, add or update events/attributes, add or updat
  * [requests](http://docs.python-requests.org)
 
 ## Install from pip
-~~~~
+
+```
 pip install pymisp
-~~~~
+```
 
 ## Install the lastest version from repo
 
-~~~~
+```
 git clone https://github.com/CIRCL/PyMISP.git && cd PyMISP
 python setup.py install
-~~~~
+```
 
 ## Samples and how to use PyMISP
 
@@ -29,21 +34,21 @@ Various examples and samples scripts are in the [examples/](examples/) directory
 
 In the examples directory, you will need to change the keys.py.sample to enter your MISP url and API key.
 
-~~~~
+```
 cd examples
 cp keys.py.sample keys.py
 vim keys.py
-~~~~
+```
 
 The API key of MISP is available in the Automation section of the MISP web interface.
 
 To test if your URL and API keys are correct, you can test with examples/last.py to
 fetch the last 10 events published.
 
-~~~~
+```
 cd examples
 python last.py -l 10
-~~~~
+```
 
 ## Documentation
 
@@ -51,6 +56,6 @@ python last.py -l 10
 
 Documentation can be generated with epydoc:
 
-~~~~
+```
 epydoc --url https://github.com/CIRCL/PyMISP --graph all --name PyMISP --pdf pymisp -o doc
-~~~~
+```

docs/source/conf.py

@@ -17,9 +17,9 @@
 # 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 os
-# import sys
+import sys
-# sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('.'))
 
 from recommonmark.parser import CommonMarkParser
 

docs/source/index.rst

@@ -11,6 +11,9 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   readme
+   modules
+
 
 
 Indices and tables