CI Doc integration (#69)

CI Doc integration

.travis.yml

@@ -3,8 +3,8 @@ stages:
   - name: test
   - name: deploy-pip
     if: tag IS present
-#  - name: deploy-mkdocs
-#    if: tag IS present
+  - name: deploy-docs
+    if: tag IS present
   - name: deploy-release
     if: tag IS present
 
@@ -49,7 +49,7 @@ jobs:
       name: "Publish to PyPi"
       python: '3.7'
       script:
-        - pip install -r test-requirements.txt
+        - pip install -r requirements-dev.txt
       deploy:
         provider: pypi
         user: AuHau-deploy
@@ -61,20 +61,28 @@ jobs:
         password:
           secure: "U3TCm2jfVDh1jlsLUMNT+3gORy7QselNgXmLaAAVeFsmOjyxDNfQ0jfo7vVuv5/lMvDEJCe/ODDnAudM0YGKXB40viz1fMUddjK5y4PrSIbNG+EZMyLYh6AJt4J6wQuINeyUBiqDM+uV9iRscsEAv/m3Hx05UACPO3RQHRSHwkE="
 
-#    - stage: deploy-mkdocs
-#      name: "Publish documentation"
-#      language: python
-#      python: '3.7'
-#      dist: xenial
-#      sudo: true
-#      install:
-#        - pip install -r test-requirements.txt
-#      script:
-#        - git config user.name "Adam Uhlir";
-#        - git config user.email "[email protected]";
-#        - git remote add gh-token "https://${GH_TOKEN}@github.com/magmax/python-inquirer.git";
-#        - git fetch gh-token && git fetch gh-token gh-pages:gh-pages;
-#        - mkdocs gh-deploy -v --clean --remote-name gh-token;
+    - stage: deploy-docs
+      name: "Publish documentation"
+      language: python
+      python: '3.7'
+      dist: xenial
+      sudo: true
+      install:
+        - pip install -r requirements-doc.txt
+        - pip install -e .
+      script:
+        - cd ./docs
+        - make html
+      deploy:
+        provider: pages
+        skip_cleanup: true
+        github_token: ${GH_TOKEN}
+        keep_history: true
+        committer_from_gh: true
+        local_dir: ./build/html/
+        on:
+          tags: true
+          repo: magmax/python-inquirer
 
     - stage: deploy-release
       name: "Create release"

README.rst

@@ -27,7 +27,7 @@ Currently the python-inquirer supports only UNIX-based platforms (eq. Mac OS, Li
 Documentation
 =============
 
-Documentation has been moved to `ReadTheDocs`_.
+Documentation has been moved to `magmax.org/python-inquirer <https://magmax.org/python-inquirer/>`_.
 
 But here you have a couple of usage examples:
 
@@ -193,20 +193,19 @@ Licensed under `the MIT license`_.
 
 
 
-.. |inquirer text| image:: http://python-inquirer.readthedocs.org/en/latest/_images/inquirer_text.png
+.. |inquirer text| image:: http://magmax.org/python-inquirer/_images/inquirer_text.png
   :alt: Example of Text Question
 
-.. |inquirer list| image:: http://python-inquirer.readthedocs.org/en/latest/_images/inquirer_list.png
+.. |inquirer list| image:: http://magmax.org/python-inquirer/_images/inquirer_list.png
   :alt: Example of List Question
 
-.. |inquirer checkbox| image:: http://python-inquirer.readthedocs.org/en/latest/_images/inquirer_checkbox.png
+.. |inquirer checkbox| image:: http://magmax.org/python-inquirer/_images/inquirer_checkbox.png
   :alt: Example of Checkbox Question
 
 .. _Inquirer.js: https://github.com/SBoudrias/Inquirer.js
 .. _Travis: https://travis-ci.org/magmax/python-inquirer
 .. _Coveralls: https://coveralls.io/r/magmax/python-inquirer
 .. _examples/: https://github.com/magmax/python-inquirer/tree/master/examples
-.. _ReadTheDocs: http://python-inquirer.readthedocs.org/
 .. _`download the python-inquirer code from GitHub`: https://github.com/magmax/python-inquirer
 .. _`download the wheel from Pypi`: https://pypi.python.org/pypi/inquirer
 

docs/source/conf.py

@@ -12,21 +12,10 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
-import os
-try:
-    import sphinx_bootstrap_theme
-except ImportError:
-    sphinx_bootstrap_theme = None
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
-#sys.path.insert(0, os.path.abspath('../../inquirer'))
-#sys.path.insert(0, os.path.abspath('.'))
 
-print sys.path
 
 # -- General configuration ------------------------------------------------
 
@@ -56,7 +45,7 @@
 
 # General information about the project.
 project = u'inquirer'
-copyright = u'2014, Miguel Ángel García'
+copyright = u'2019, Miguel Ángel García & Adam Uhlíř'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -114,7 +103,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'bootstrap' if sphinx_bootstrap_theme else 'default'
+html_theme = 'alabaster'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -123,8 +112,6 @@
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
-if sphinx_bootstrap_theme:
-    html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".

requirements-doc.txt

@@ -1,2 +1 @@
 sphinx
-sphinx-bootstrap-theme