A GitHub Pages import tool.
Project description
A dumb GitHub Pages import tool. Packaging is fixed here.
Warning
This will DESTROY your gh-pages branch. If you love it, you’ll want to take backups before playing with this. This script assumes that gh-pages is 100% derivative. You should never edit files in your gh-pages branch by hand if you’re using this script because you will lose your work.
Usage
Usage: ghp-import [OPTIONS] DIRECTORY
- Options:
- -n
Include a .nojekyll file in the branch.
- -m MESG
The commit message to use on the target branch.
- -p
Push the branch to origin/{branch} after committing.
- -r REMOTE
The name of the remote to push to. [origin]
- -b BRANCH
Name of the branch to write to. [gh-pages]
- -h, --help
show this help message and exit
Its pretty simple. Inside your repository just run ghp-import $DOCS_DIR where $DOCS_DIR is the path to the built documentation. This will write a commit to your gh-pages branch with the current documents in it.
If you specify -p it will also attempt to push the gh-pages branch to GitHub. By default it’ll just run git push origin gh-pages. You can specify a different remote using the -r flag.
You can specify a different branch with -b. This is useful for user and organization page, which are served from the master branch.
ghp-import also recognizes the GIT_DIR environment variable which can be useful for Git hooks.
License
ghp-import is distributed under the Tumbolia Public License. See the LICENSE file for more information.
Changelog
1.0.0 (2015-05-09)
First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ghp_import2-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94185c7e0aec346c44151a0518ff8c6edf662afdcc942387d881382a2c03a6df |
|
MD5 | 312b23e4436059da6bc3357ca415a86b |
|
BLAKE2b-256 | 46d5e4584f33f36fd633f5513c3b7c3522cde4745b3471b95cab3f2599d7e299 |