docs

Instructions for Generating Documentation with Sphinx

INSTALL SPHINX:

pip3 install -U Sphinx

MAKE NEW DOCS IN MASTER BRANCH:

git clone [email protected]:geduldig/TwitterAPI.git
cd TwitterAPI/docs
vi conf.py (modify version and release)
make html

TEST DOC WEB PAGE:

TwitterAPI/docs/_build/html/index.html

DOWNLOAD OLD DOCS FROM GH-PAGES BRANCH:

git clone -b gh-pages [email protected]:geduldig/TwitterAPI.git

COPY NEW DOCS OVER OLD DOCS:

cp ./_build/html/*.* ./TwitterAPI
cp -r ./_build/html/* ./TwitterAPI
rm -r ./_build

UPLOAD NEW DOCS TO GH-PAGES BRANCH::

cd TwitterAPI
git commit -am "2.5 docs"
git push origin gh-pages