bucket_A2/python-ghp-import

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-ghp-import
   4 VERSION=                2.1.0
   5 KEYWORDS=               python
   6 VARIANTS=               py310 py311
   7 SDESC[py310]=           Copies docs directly to gh-pages branch (3.10)
   8 SDESC[py311]=           Copies docs directly to gh-pages branch (3.11)
   9 HOMEPAGE=               https://github.com/c-w/ghp-import
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/f7/ec/67fbef5d497f86283db54c22eec6f6140243aae73265799baaaa19cd17fb
  14 DISTFILE[1]=            ghp_import-2.1.0-py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[py310]=           single
  17 SPKGS[py311]=           single
  18
  19 OPTIONS_AVAILABLE=      PY310 PY311
  20 OPTIONS_STANDARD=       none
  21 VOPTS[py310]=           PY310=ON PY311=OFF
  22 VOPTS[py311]=           PY310=OFF PY311=ON
  23
  24 DISTNAME=               ghp_import-2.1.0.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY310].RUN_DEPENDS_ON=                 python-python-dateutil:single:py310
  29 [PY310].USES_ON=                        python:py310,wheel
  30
  31 [PY311].RUN_DEPENDS_ON=                 python-python-dateutil:single:py311
  32 [PY311].USES_ON=                        python:py311,wheel
  33
  34 [FILE:3595:descriptions/desc.single]
  35 GitHub Pages Import
  36 ===================
  37
  38 [CI status]
  39 [CircleCI]
  40 [TravisCI]
  41
  42 [License]
  43 [Version]
  44
  45 As part of [gunicorn][gunicorn], [Benoit Chesneau][benoit] and [Paul
  46 Davis][davisp]
  47 were looking at how to host documentation. There's the obvious method of
  48 using [GitHub's post-receive hook][github-post] to trigger doc builds and
  49 rsync
  50 to a webserver, but we ended up wanting to try out github's hosting to make
  51 the
  52 whole interface a bit more robust.
  53
  54 [GitHub Pages][gh-pages] is a pretty awesome service that GitHub provides
  55 for
  56 hosting project documentation. The only thing is that it requires a
  57 `gh-pages` branch that is the site's document root. This means that keeping
  58 documentation sources in the branch with code is a bit difficult. And it
  59 really
  60 turns into a head scratcher for things like [Sphinx][sphinx] that want to
  61 access documentation sources and code sources at the same time.
  62
  63 Then we stumbled across an interesting looking package called
  64 [github-tools][github-tools] that looked almost like what we wanted. It was
  65 a tad
  66 complicated and more involved than we wanted but it gave us an idea. Why
  67 not
  68 just write a script that can copy a directory to the `gh-pages` branch of
  69 the
  70 repository. This saves us from even having to think about the branch and
  71 everything becomes magical.
  72
  73 This is what `ghp-import` was written for.
  74
  75 [gunicorn]: http://www.gunicorn.com/ "Gunicorn"
  76 [benoit]: http://github.com/benoitc "Benoît Chesneau"
  77 [davisp]: http://github.com/davisp "Paul J. Davis"
  78 [github-post]: https://help.github.com/articles/post-receive-hooks "GitHub
  79 Post-Receive Hook"
  80 [gh-pages]: http://pages.github.com/ "GitHub Pages"
  81 [sphinx]: http://sphinx.pocoo.org/ "Sphinx Documentation"
  82 [github-tools]: http://dinoboff.github.com/github-tools/ "github-tools"
  83
  84 Big Fat Warning
  85 ---------------
  86
  87 This will **DESTROY** your `gh-pages` branch. If you love it, you'll want
  88 to
  89 take backups before playing with this. This script assumes that `gh-pages`
  90 is
  91 100% derivative. You should never edit files in your `gh-pages` branch by
  92 hand
  93 if you're using this script because you will lose your work.
  94
  95 When used with a prefix, only files below the set prefix will be destroyed,
  96 limiting the
  97 above warning to just that directory and everything below it.
  98
  99 Usage
 100 -----
 101
 102 ```
 103 Usage: ghp-import [OPTIONS] DIRECTORY
 104
 105 Options:
 106   -n, --no-jekyll       Include a .nojekyll file in the branch.
 107   -c CNAME, --cname=CNAME
 108                         Write a CNAME file with the given CNAME.
 109   -m MESG, --message=MESG
 110                         The commit message to use on the target branch.
 111   -p, --push            Push the branch to origin/{branch} after
 112 committing.
 113   -x PREFIX, --prefix=PREFIX
 114                         The prefix to add to each file that gets pushed to
 115 the
 116                         remote. Only files below this prefix will be
 117 cleared
 118                         out. [none]
 119   -f, --force           Force the push to the repository.
 120   -o, --no-history      Force new commit without parent history.
 121   -r REMOTE, --remote=REMOTE
 122                         The name of the remote to push to. [origin]
 123   -b BRANCH, --branch=BRANCH
 124                         Name of the branch to write to. [gh-pages]
 125   -s, --shell           Use the shell when invoking Git. [False]
 126   -l, --follow-links    Follow symlinks when adding files. [False]
 127   -h, --help            show this help message and exit
 128 ```
 129
 130 Its pretty simple. Inside your repository just run `ghp-import $DOCS_DIR`
 131 where `$DOCS_DIR` is the path to the **built** documentation. This will
 132 write a
 133 commit to your `gh-pages` branch with the current documents in it.
 134
 135
 136
 137 [FILE:112:distinfo]
 138 8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619        11034 ghp_import-2.1.0-py3-none-any.whl
 139