This is the sequence of steps to follow to create a root gh-pages
branch. It is based on a question at [SO]
cd /path/to/repo-name
git symbolic-ref HEAD refs/heads/gh-pages
rm .git/index
git clean -fdx
echo "My GitHub Page" > index.html
# assume the following directory structure where contents of doc/ | |
# and source/ are already checked into repo., with the exception | |
# of the _build directory (i,e. you can check in _themes or _sources | |
# or whatever else). | |
# | |
# proj/ | |
# source/ | |
# doc/ | |
# remove doc/_build/html if present |
create different ssh key according the article Mac Set-Up Git
$ ssh-keygen -t rsa -C "your_email@youremail.com"
# Repeat an operation n times, e.g. | |
# @dotimes 100 println("hi") | |
macro dotimes(n, body) | |
quote | |
for i = 1:$(esc(n)) | |
$(esc(body)) | |
end | |
end | |
end |
# docs/Makefile.dash | |
include Makefile | |
PROJECT_NAME = $(shell python ../setup.py --name) | |
.PHONY: dashdoc | |
dashdoc: | |
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) -D 'html_theme=epub' $(BUILDDIR)/dashdoc | |
doc2dash -A -v -n $(PROJECT_NAME) -d $(BUILDDIR)/ -f -I index.html -j $(BUILDDIR)/dashdoc | |
@echo | |
@echo "Build finished. The Docset is in $(BUILDDIR)/$(PROJECT_NAME).docset." |
Follow the instructions on Github to Create an Access Token in Github
By default, git credentials are not cached so you need to tell Git if you want to avoid having to provide them each time Github requires you to authenticate. On Mac, Git comes with an “osxkeychain” mode, which caches credentials in the secure keychain that’s attached to your system account.
You can tell Git you want to store credentials in the osxkeychain by running the following:-
{ | |
"Ambiguous Double Width": false, | |
"Ansi 0 Color": { | |
"Alpha Component": 1, | |
"Blue Component": 0.27058824896812439, | |
"Color Space": "sRGB", | |
"Green Component": 0.24705882370471954, | |
"Red Component": 0.23529411852359772 | |
}, | |
"Ansi 1 Color": { |
[ | |
{ | |
"identifier": { | |
"id": "vscode.bat" | |
}, | |
"pinned": false, | |
"preRelease": false, | |
"version": "1.0.0" | |
}, | |
{ |
using IOCapture | |
export livecheck, bump_cask_pr | |
function livecheck(cask) | |
try | |
c = IOCapture.capture() do | |
run(`brew livecheck --cask $cask`) | |
end | |
str = c.output |