help_pages's Introduction

The PythonAnywhere Help Pages

This repo contains the source files for help.pythonanywhere.com. They are stored in markdown format and converted to html by the Nikola static site generator. Individual help pages can be found in the "articles" folder.

Pull requests are welcome! The only page for which we can't accept them are the API docs, which are auto-generated from our code -- if you find a problem with them, then you can let us know by raising an issue on the GitHub repository.

(for PA developers): pushing changes to live

A post-receive hook will take care of the nikola build and deploy

git remote add live-site [email protected]:/home/help/barerepo.git
# you'll probably want to add your public key to help's authorized_keys
git push live-site master

generating the help pages manually

The sources, if you need to rebuild manually are in /var/www/nikola-sources

For whatever reason...

workon nikola
nikola build
nikola deploy  # nb this has a hard-coded path to a static files directory for the web app, so don't run it on your own pc

Git stuff

The git post-receive hook (in /home/help/barerepo.git/hooks), in case it gets killed is:

#!/bin/bash
export GIT_WORK_TREE=/var/www/nikola-sources
mkdir -p $GIT_WORK_TREE
git checkout -f
echo "begin nikola build: "`date` >> /home/help/deploy-log.txt
cd $GIT_WORK_TREE
/home/help/.virtualenvs/nikola/bin/nikola check --clean-files
rm -f output/assets/js/tipuesearch_content.json
/home/help/.virtualenvs/nikola/bin/nikola build
/home/help/.virtualenvs/nikola/bin/nikola deploy
echo "deploy completed: "`date` >> /home/help/deploy-log.txt

Recommend Projects