Skip to main content

Copy your docs directly to the dedicate branch.

Project description

raw-import is a fork of ghp-import to be more generic on branch name under Git repository,

It’s possible to generate documentation wit Sphinx, and publish the result of make html under the specify branch

Big Fat Warning

This will DESTROY your dedicate branch. If you love it, you’ll want to take backups before playing with this. This script assumes that 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: raw-import [OPTIONS] DIRECTORY

Options:
  -m MESG     The commit message to use on the gh-pages branch.
  -p          Push the branch to origin/gh-pages after committing.
  -r REMOTE   The name of the remote to push to. [origin]
  -b BRANCH   The name of the dedicate branch. [pages]
  -h, --help  show this help message and exit

Its pretty simple. Inside your repository just run raw-import $DOCS_DIR where $DOCS_DIR is the path to the built documentation. This will write a commit to your dedicate branch with the current documents in it.

If you specify -b it can be possible to specify the name of the branch.

If you specify -p it will also attempt to push the dedicate branch to GitHub. By default it’ll just run git push origin pages. You can specify a different remote using the -r flag.

License

raw-import is distributed under the same license as ghp-import (the Tumbolia Public License. See the LICENSE file for more information).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

raw-import-0.1.1.tar.gz (3.9 kB view details)

Uploaded Source

File details

Details for the file raw-import-0.1.1.tar.gz.

File metadata

  • Download URL: raw-import-0.1.1.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for raw-import-0.1.1.tar.gz
Algorithm Hash digest
SHA256 10d8b0f041ad0bec8bd5ccdd77d51b87a2170bc75e842728eee001d4f7dfe72e
MD5 996e869091fec455a15cbcae7919f951
BLAKE2b-256 4671d3f9b82e55a0490b540e205b4447297ab68a1ba7617b52ecc3db7b32cf3e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page