Basic Installation of Sphinx and Ablog¶

Steps¶

The following steps should work independently of what system you have. On Linux it may be necessary to prepend “sudo”.

1. Go to the commandline an verify that you have Python available:

   $ python --version
   Python 2.7.7
   

   You should see a 2.7 or 2.6 version or maybe a 3.x. All of those are fine.

2. If Python is missing, see https://www.python.org/ and install it! That should be very easy and should not harm your system at all.

3. Verify that the Python packet manager “pip” is available:

   $ pip --help
   
   Usage:
     pip <command> [options]
   
   ...
   

4. If “pip” is missing, install it. See https://pypi.python.org/pypi for this. You are advised to get pip which means that you securely download the file get-pip.py.

   Run that file with Python:

   $ python get-pip.py
   

5. Play with “pip”:

   $ pip --help
   $ pip list
   $ pip show sphinx
   $ pip search sphinx
   $ pip show ablog
   $ pip search ablog
   

   Further you can uninstall or update packages with “pip”:

   $ pip uninstall <package-name>
   $ pip update <package-name>
   

6. Install Sphinx:

   $ pip install -U sphinx
   

   See http://sphinx-doc.org/ for what you get. To launch a new Sphinx documentation project go to a new, empty folder and run sphinx-quickstart.

7. Install Ablog:

   $ pip install -U alabaster # I'm not sure this necessary
   $ pip install -U werkzeug  # I'm not sure this necessary
   $ pip install -U ablog
   

   See http://ablog.readthedocs.org/ for what you get.

8. To start a blog:

   Download the /docs folder from https://github.com/abakan/ablog/tree/master/docs as a complete blog example. See http://ablog.readthedocs.org/ for what you get! Run “make” or “make.bat” to generate output in _build/html.

9. Start “_build/html/index.html” in your browser to see your blog.

Enjoy!