genindex.html


<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Index &#8212; Doctr 1.8.0+13.g7e75711 documentation</title>
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <link rel="index" title="Index" href="#" />
    <link rel="search" title="Search" href="search.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
 <a href="#Symbols"><strong>Symbols</strong></a>
 | <a href="#A"><strong>A</strong></a>
 | <a href="#C"><strong>C</strong></a>
 | <a href="#D"><strong>D</strong></a>
 | <a href="#E"><strong>E</strong></a>
 | <a href="#F"><strong>F</strong></a>
 | <a href="#G"><strong>G</strong></a>
 | <a href="#I"><strong>I</strong></a>
 | <a href="#L"><strong>L</strong></a>
 | <a href="#M"><strong>M</strong></a>
 | <a href="#P"><strong>P</strong></a>
 | <a href="#R"><strong>R</strong></a>
 | <a href="#S"><strong>S</strong></a>
 | <a href="#U"><strong>U</strong></a>
 
</div>
<h2 id="Symbols">Symbols</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    --branch-whitelist &lt;branch&gt;

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-branch-whitelist">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --build-tags

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-build-tags">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --built-docs &lt;built_docs&gt;

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-built-docs">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --command &lt;command&gt;

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-command">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --deploy-branch-name &lt;deploy_branch_name&gt;

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-deploy-branch-name">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --deploy-repo &lt;deploy_repo&gt;

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-deploy-repo">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --exclude &lt;exclude&gt;

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-exclude">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --force

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-configure-force">doctr-configure command line option</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-force">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --gh-pages-docs &lt;gh_pages_docs&gt;

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-gh-pages-docs">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --help

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-h">doctr command line option</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-configure-h">doctr-configure command line option</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-h">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --key-path &lt;key_path&gt;

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-configure-key-path">doctr-configure command line option</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-key-path">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --no-authenticate

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-configure-no-authenticate">doctr-configure command line option</a>
</li>
      </ul></li>
      <li>
    --no-build-tags

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-build-tags">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --no-force

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-force">doctr-deploy command line option</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    --no-push

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-push">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --no-require-master

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-require-master">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --no-sync

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-sync">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --no-temp-dir

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-temp-dir">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --no-token

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-token">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --no-upload-key

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-configure-no-upload-key">doctr-configure command line option</a>
</li>
      </ul></li>
      <li>
    --push

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-push">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --require-master

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-require-master">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --sync

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-sync">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --token

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-configure-token">doctr-configure command line option</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-token">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    --travis-tld {c,com,.com,travis-ci.com,o,org,.org,travis-ci.org}

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-configure-travis-tld">doctr-configure command line option</a>
</li>
      </ul></li>
      <li>
    --version

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-V">doctr command line option</a>
</li>
      </ul></li>
      <li>
    -h

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-h">doctr command line option</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-configure-h">doctr-configure command line option</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-h">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li>
    -V

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-V">doctr command line option</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.local.AuthenticationFailed">AuthenticationFailed</a>
</li>
  </ul></td>
</tr></table>

<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.local.check_repo_exists">check_repo_exists() (in module doctr.local)</a>
</li>
      <li><a href="api.html#doctr.travis.checkout_deploy_branch">checkout_deploy_branch() (in module doctr.travis)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.travis.commit_docs">commit_docs() (in module doctr.travis)</a>
</li>
      <li><a href="api.html#doctr.travis.copy_to_tmp">copy_to_tmp() (in module doctr.travis)</a>
</li>
      <li><a href="api.html#doctr.travis.create_deploy_branch">create_deploy_branch() (in module doctr.travis)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.travis.decrypt_file">decrypt_file() (in module doctr.travis)</a>
</li>
      <li><a href="api.html#doctr.local.delete_GitHub_token">delete_GitHub_token() (in module doctr.local)</a>
</li>
      <li><a href="api.html#doctr.travis.deploy_branch_exists">deploy_branch_exists() (in module doctr.travis)</a>
</li>
      <li>
    deploy_directory

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-arg-deploy_directory">doctr-deploy command line option</a>
</li>
      </ul></li>
      <li><a href="api.html#doctr.travis.determine_push_rights">determine_push_rights() (in module doctr.travis)</a>
</li>
      <li>
    doctr command line option

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-h">--help</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-V">--version</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-h">-h</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-V">-V</a>
</li>
      </ul></li>
      <li>
    doctr-configure command line option

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-configure-force">--force</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-configure-h">--help</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-configure-key-path">--key-path &lt;key_path&gt;</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-configure-no-authenticate">--no-authenticate</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-configure-no-upload-key">--no-upload-key</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-configure-token">--token</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-configure-travis-tld">--travis-tld {c,com,.com,travis-ci.com,o,org,.org,travis-ci.org}</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-configure-h">-h</a>
</li>
      </ul></li>
      <li>
    doctr-deploy command line option

      <ul>
        <li><a href="commandline.html#cmdoption-doctr-deploy-branch-whitelist">--branch-whitelist &lt;branch&gt;</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-build-tags">--build-tags</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-built-docs">--built-docs &lt;built_docs&gt;</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-command">--command &lt;command&gt;</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-deploy-branch-name">--deploy-branch-name &lt;deploy_branch_name&gt;</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-deploy-repo">--deploy-repo &lt;deploy_repo&gt;</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-exclude">--exclude &lt;exclude&gt;</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-force">--force</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-gh-pages-docs">--gh-pages-docs &lt;gh_pages_docs&gt;</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-h">--help</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-key-path">--key-path &lt;key_path&gt;</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-build-tags">--no-build-tags</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-force">--no-force</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-push">--no-push</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-require-master">--no-require-master</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-sync">--no-sync</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-temp-dir">--no-temp-dir</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-no-token">--no-token</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-push">--push</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-require-master">--require-master</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-sync">--sync</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-token">--token</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-h">-h</a>
</li>
        <li><a href="commandline.html#cmdoption-doctr-deploy-arg-deploy_directory">deploy_directory</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    doctr.local

      <ul>
        <li><a href="api.html#module-doctr.local">module</a>
</li>
      </ul></li>
      <li>
    doctr.travis

      <ul>
        <li><a href="api.html#module-doctr.travis">module</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.local.encrypt_to_file">encrypt_to_file() (in module doctr.local)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.local.encrypt_variable">encrypt_variable() (in module doctr.local)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.travis.find_sphinx_build_dir">find_sphinx_build_dir() (in module doctr.travis)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.local.generate_GitHub_token">generate_GitHub_token() (in module doctr.local)</a>
</li>
      <li><a href="api.html#doctr.local.generate_ssh_key">generate_ssh_key() (in module doctr.local)</a>
</li>
      <li><a href="api.html#doctr.travis.get_current_repo">get_current_repo() (in module doctr.travis)</a>
</li>
      <li><a href="api.html#doctr.travis.get_token">get_token() (in module doctr.travis)</a>
</li>
      <li><a href="api.html#doctr.travis.get_travis_branch">get_travis_branch() (in module doctr.travis)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.local.get_travis_token">get_travis_token() (in module doctr.local)</a>
</li>
      <li><a href="api.html#doctr.local.GitHub_login">GitHub_login() (in module doctr.local)</a>
</li>
      <li><a href="api.html#doctr.local.GitHub_post">GitHub_post() (in module doctr.local)</a>
</li>
      <li><a href="api.html#doctr.local.GitHub_raise_for_status">GitHub_raise_for_status() (in module doctr.local)</a>
</li>
      <li><a href="api.html#doctr.local.GitHubError">GitHubError</a>
</li>
      <li><a href="api.html#doctr.local.guess_github_repo">guess_github_repo() (in module doctr.local)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.travis.is_subdir">is_subdir() (in module doctr.travis)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.travis.last_commit_by_doctr">last_commit_by_doctr() (in module doctr.travis)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    module

      <ul>
        <li><a href="api.html#module-doctr.local">doctr.local</a>
</li>
        <li><a href="api.html#module-doctr.travis">doctr.travis</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.travis.push_docs">push_docs() (in module doctr.travis)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.travis.run">run() (in module doctr.travis)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.travis.set_git_user_email">set_git_user_email() (in module doctr.travis)</a>
</li>
      <li><a href="api.html#doctr.travis.setup_deploy_key">setup_deploy_key() (in module doctr.travis)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.travis.setup_GitHub_push">setup_GitHub_push() (in module doctr.travis)</a>
</li>
      <li><a href="api.html#doctr.travis.sync_from_log">sync_from_log() (in module doctr.travis)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#doctr.local.upload_GitHub_deploy_key">upload_GitHub_deploy_key() (in module doctr.local)</a>
</li>
  </ul></td>
</tr></table>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Doctr</a></li>
<li class="toctree-l1"><a class="reference internal" href="commandline.html">Doctr Command Line Help</a></li>
<li class="toctree-l1"><a class="reference internal" href="recipes.html">Recipes</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Doctr Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasing.html">Releasing</a></li>
<li class="toctree-l1"><a class="reference internal" href="tests.html">Notes for testing doctr</a></li>
</ul>
<h3>Need help?</h3>

<p>
  Open an issue in our <a href="https://github.com/drdoctr/doctr/issues">issue
  tracker</a>. Issues that are just questions are fine.
</p>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2016, Aaron Meurer and Gil Forsyth.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
    </div>

    
    <a href="https://github.com/drdoctr/doctr" class="github">
        <img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"  class="github"/>
    </a>
    

  </body>
</html>