isabella232 / quickpin

New iteration of QuickPin with Flask & AngularDart

QuickPin

QuickPin is a tool for quickly examining social networks, such as Twitter, to identify individuals and groups that are related to specified topics.

Read the documentation.

Compiling documentation

Requirements:

• QuickPin dependencies (inc Sphinx).
• Pandoc.
• QuickPin Python dependencies.

There is a seperate branch used for compiling the documenation('rtd'). This contains a method to allow sphinxcontrib.httpdomain.flask to generate the API endpoint documentation.

Checkout the 'rtd' branch

$ git fetch
$ git checkout rtd
$ git rebase master

Rebase ensures the 'rtd' branch is up to date with changes to master.

Create PDF

$ cd docs 
$ make latexpdf

Unless otherwise specified, output is created in docs/_build/latexpdf (excluded from github repository).

Create HTML

$ cd docs 
$ make html

Unless otherwise specified, output is created in docs/_build/html (excluded from github repository).

Create Markdown

$ cd docs 
$ python make_markdown.py

This scripts builds a single html file with Sphinx, converts it to markdown with Pandoc, and applies some formatting tweaks.

Output is created in docs/_build/markdown (excluded from github repository).