freesmartphone.org top-level documentation

This project is using mkdocs.

Note that the devel branch contains the actual source and the master branch should only contain the site subdirectory.

If you want to commit an update, please only change the md files (not the HTML files) and then call the following sequence of commands:

mkdocs build – this will rebuild the html files

git commit -a -m"your message" – this will commit your changes

git push – this will push the changes to devel

git subtree push --prefix site origin master – this will push the site subdirectory to master and triggers github to rebuild our site documentation at www.freesmartphone.org

If you get the error

Building documentation to directory: site
Traceback (most recent call last):
  File "/usr/local/lib/python3.4/dist-packages/markdown/__init__.py", line 197, in build_extension
    module = __import__(module_name, {}, {}, [module_name.rpartition('.')[0]])
ImportError: No module named 'markdown.extensions.smartypants'

then you need to install the python module mdx_smartypants, i.e. ```pip3 install mdx_smartypants`.