change docs build dir

docs/source/conf.py → docs/conf.py

 # -*- coding: utf-8 -*-
-#
-# PyOTRS documentation build configuration file, created by
-# sphinx-quickstart on Thu Apr 14 22:10:43 2016.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
 import sys
 import os
 
@@ -41,6 +28,8 @@ extensions = [
     'sphinx.ext.autosummary',
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
+    'sphinx.ext.coverage',
+    'sphinx.ext.extlinks',
     'sphinxcontrib.napoleon',
 ]
 
@@ -118,8 +107,8 @@ pygments_style = 'sphinx'
 #keep_warnings = False
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
-
+todo_include_todos = True
+todo_link_only = True
 
 # -- Options for HTML output ----------------------------------------------
 
@@ -305,6 +294,12 @@ texinfo_documents = [
 #texinfo_no_detailmenu = False
 
 
+
+extlinks = {
+    'issue': ('https://gitlab.com/rhab/PyOTRS/issues/%s', '#'),
+    'mr': ('https://gitlab.com/rhab/PyOTRS/pull/%s', 'PR #'),
+}
+
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'https://docs.python.org/': None}
 
@@ -314,5 +309,3 @@ intersphinx_mapping = {'https://docs.python.org/': None}
 # 'groupwise', 'bysource', default: 'alphabetical'
 autodoc_member_order = 'groupwise'
 
-todo_include_todos = True
-todo_link_only = True

docs/source/contributing_pandoc.txt → docs/contributing_pandoc.txt

 Contributing
 ============
 
-Dependencies-Dev
-----------------
-
-Dependencies-Docs
------------------
+Dependencies Tests/Developement (pip)
+-------------------------------------
+
+-  tox
+-  coverage
+-  unittest2
+-  mock
+-  responses
+
+Dependencies Documentation (pip)
+--------------------------------
+
+-  sphinx
+-  sphinxcontrib-napoleon
+-  sphinx\_rtd\_theme
+-  pandoc (**apt-get install pandoc)**
 
 Running Tests
 -------------

cov_docs_build_deploy.sh → docs_cov_build_deploy.sh

@@ -7,9 +7,10 @@ sudo rm -rf /var/www/PyOTRS/htmlcov
 coverage html -d htmlcov
 sudo cp -a htmlcov /var/www/PyOTRS/
 
-# coverage: clean, build, deploy
-rm -rf docs/build
+# docs: clean, build, deploy
+rm -rf build/docs
 sudo rm -rf /var/www/PyOTRS/docs
 tox -e docs
-sudo cp -a docs/build /var/www/PyOTRS/docs
+#sudo cp -a docs/build /var/www/PyOTRS/docs
+sudo cp -a build/docs /var/www/PyOTRS/docs
 

tox.ini

@@ -9,7 +9,8 @@ envlist =
     py34,
     cov_combine,
     py3kwarn,
-    pep8
+    pep8,
+    docs
 
 [testenv]
 deps =