Skip to content

Files

Latest commit

358ef6a · Nov 12, 2021

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Nov 3, 2015
Nov 12, 2021
Mar 17, 2018
Nov 12, 2021
Mar 17, 2018
Mar 15, 2018
Mar 17, 2018
Mar 17, 2018
Mar 17, 2018
Nov 3, 2015
Nov 3, 2015
Nov 3, 2015
Mar 15, 2018

Instructions for Generating Documentation with Sphinx

INSTALL SPHINX:

pip3 install -U Sphinx

MAKE NEW DOCS IN MASTER BRANCH:

git clone git@github.com: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 git@github.com: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
CLEAN UP::
cd .. rm -r TwitterAPI