Rename to doctr and add a setup.py

.gitattributes

@@ -0,0 +1 @@
+doctr/_version.py export-subst

.travis.yml

@@ -20,9 +20,9 @@ script:
       cd docs;
       make html;
       cd ..;
-      python -m travis_docs_builder gforsyth/travis_docs_builder;
+      python -m doctr gforsyth/doctr;
     fi
 
   - if [[ "${TESTS}" == "true" ]]; then
-      pyflakes travis_docs_builder;
+      pyflakes doctr;
     fi

MANIFEST.in

@@ -0,0 +1,2 @@
+include versioneer.py
+include doctr/_version.py

README.rst

@@ -14,7 +14,7 @@ Run
 
 .. code::
 
-   python -m travis_docs_builder
+   python -m doctr
 
 and enter your data. You will need your GitHub username and password, and the
 repo you want to build the docs for.
@@ -37,14 +37,14 @@ secure key to add. You should also have something like
    sudo: false
    env:
      global:
-       secure: "<your secure key from python -m travis_docs_builder here>"
+       secure: "<your secure key from doctr here>"
 
    script:
      - pip install requests cryptography sphinx
      - cd docs
      - make html
      - cd ..
-     - python -m travis_docs_builder <your repo name>
+     - doctr <your repo name>
 
 
 in your ``.travis.yml``. See `the one <.travis.yml>`_ in this repo for example.

docs/api.rst

@@ -5,11 +5,11 @@
 Local
 =====
 
-.. automodule:: travis_docs_builder.local
+.. automodule:: doctr.local
    :members:
 
 Travis
 ======
 
-.. automodule:: travis_docs_builder.travis
+.. automodule:: doctr.travis
    :members:

docs/conf.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
-# Travis docs builder documentation build configuration file, created by
+# Doctr documentation build configuration file, created by
 # sphinx-quickstart on Sun Jul 17 15:34:54 2016.
 #
 # This file is execfile()d with the current directory set to its
@@ -21,6 +21,8 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('..'))
 
+import doctr
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -50,7 +52,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'Travis docs builder'
+project = 'Doctr'
 copyright = '2016, Aaron Meurer and Gil Forsyth'
 author = 'Aaron Meurer and Gil Forsyth'
 
@@ -59,9 +61,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.0'
+version = doctr.__version__
 # The full version, including alpha/beta/rc tags.
-release = '1.0'
+release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -125,7 +127,7 @@
 
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
-#html_title = 'Travis docs builder v1.0'
+#html_title = 'Doctr v1.0'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
@@ -207,7 +209,7 @@
 #html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Travisdocsbuilderdoc'
+htmlhelp_basename = 'doctrdoc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -229,7 +231,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'Travisdocsbuilder.tex', 'Travis docs builder Documentation',
+    (master_doc, 'doctr.tex', 'Doctr Documentation',
      'Aaron Meurer and Gil Forsyth', 'manual'),
 ]
 
@@ -259,7 +261,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'travisdocsbuilder', 'Travis docs builder Documentation',
+    (master_doc, 'doctr', 'Doctr Documentation',
      [author], 1)
 ]
 
@@ -273,8 +275,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'Travisdocsbuilder', 'Travis docs builder Documentation',
-     author, 'Travisdocsbuilder', 'One line description of project.',
+    (master_doc, 'Doctr', 'Doctr Documentation',
+     author, 'Doctr', 'One line description of project.',
      'Miscellaneous'),
 ]
 

travis_docs_builder/__init__.py → doctr/__init__.py

@@ -8,3 +8,7 @@
     'get_token', 'run', 'setup_GitHub_push', 'gh_pages_exists',
     'create_gh_pages', 'commit_docs', 'push_docs',
 ]
+
+from ._version import get_versions
+__version__ = get_versions()['version']
+del get_versions