Skip to content
May 27, 2015 / Pratik

Building Flask’s Documentation

For those who don’t know, Flask is a micro framework for making web sites. One day, I went to Flask’s website and I encountered a 404 when I was trying to download the documentation in zipped HTML form. From time to time, I feel it is really convenient to have offline documentation. Since, I feel it’s important to have documentation offline I went off to build the documentation from Flask’s tarball. Here are the steps to build Flask’s documentation in Arch Linux.

Create a Virtual Environment for Flask and activate it

$ virtualenv2 flask-env
$ source flask-env/bin/activate

Install sphinx in that virtual environment

(flask-env)$ pip install sphinx

Install Flask in “Development Mode”

(flask-env)$ tar -zxvf Flask-0.10.1.tar.gz
(flask-env)$ cd Flask-0.10.1
(flask-env)$ python setup.py develop

Make the Documentation

(flask-env)$ make -C docs html

Go to the Freshly Built Documentation

(flask-env)$ xdg-open docs/_build/html/index.html
Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: