Repository :
http://git.fedorahosted.org/cgit/copr.git
On branch : master
---------------------------------------------------------------
commit ea954f8a4a0aebefa5ef96a0018e90ed0c53bae5
Author: Valentin Gologuzov <vgologuz(a)redhat.com>
Date: Fri Apr 10 18:22:29 2015 +0200
[backend] new documentation cleanup, fixes for RTHD
---------------------------------------------------------------
backend/docs/requirements.txt | 6 +++
backend/docs/source/conf.py | 19 ++++++-----
backend/documentation/Makefile | 34 --------------------
.../how-to-generate-documentation.txt | 10 ------
4 files changed, 16 insertions(+), 53 deletions(-)
diff --git a/backend/docs/requirements.txt b/backend/docs/requirements.txt
index 852b7a8..3ce5fb3 100644
--- a/backend/docs/requirements.txt
+++ b/backend/docs/requirements.txt
@@ -3,9 +3,15 @@ PyYAML
setproctitle
redis
# retask
+six
+mock
+requests
python-daemon
bunch
IPy
+psutil
+lockfile
+
# documentation
sphinx
diff --git a/backend/docs/source/conf.py b/backend/docs/source/conf.py
index 839d2cd..6d3a878 100644
--- a/backend/docs/source/conf.py
+++ b/backend/docs/source/conf.py
@@ -17,17 +17,18 @@ from subprocess import call
TO_INSTALL = [
# "redis",
- "retask"
+ "retask",
+ "ansible",
]
-for pkg in TO_INSTALL:
- call(["pip", "install", pkg])
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+if on_rtd:
+ for pkg in TO_INSTALL:
+ print(call(["pip", "install", "--upgrade", pkg]))
+
+ print(call("python ../../../python/setup.py install".split()))
-# on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
-# if on_rtd:
-# # html_theme = 'default'
-# call("python ../../../python/setup.py install".split())
# else:
# # html_theme = 'nature'
# pass
@@ -36,8 +37,8 @@ for pkg in TO_INSTALL:
# 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(os.path.abspath('../../../python/'))
-print(call(["ls", "-lah"]))
+sys.path.append(os.path.abspath('../../../python/'))
+
# -- General configuration -----------------------------------------------------
diff --git a/backend/documentation/Makefile b/backend/documentation/Makefile
deleted file mode 100644
index 06216f0..0000000
--- a/backend/documentation/Makefile
+++ /dev/null
@@ -1,34 +0,0 @@
-# Copyright 2008, Steve 'Ashcrow' Milner <smilner(a)redhat.com>
-#
-# This software may be freely redistributed under the terms of the GNU
-# general public license.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-BUILD_DIR := build
-
-# Python doc related
-EPYDOC_BIN := `which epydoc`
-EPYDOC_SWITCHES := --inheritance listed --graph all --html
-PYTHON_DOC_DIR := python-doc
-PYTHON_DIRS := ../
-
-# TARGETS
-# schema is not incldued here, since you need a live db
-all: python
-
-python:
- mkdir -p $(BUILD_DIR)/py-doc-build
- $(SHELL ulimit -n 4096)
- echo "[epydoc]" > $(BUILD_DIR)/epydoc.lst
- echo -n "modules: " >> $(BUILD_DIR)/epydoc.lst
- find $(PYTHON_DIRS) -type f -name '*.py' | grep -v test | xargs echo -n >>
$(BUILD_DIR)/epydoc.lst
- $(EPYDOC_BIN) $(EPYDOC_SWITCHES) -o $(PYTHON_DOC_DIR) --config $(BUILD_DIR)/epydoc.lst
-
-clean:
- rm -rf build/
-
-distclean:
- rm -rf build/ $(PYTHON_DOC_DIR) $(JAVA_DOC_DIR) $(SCHEMA_DOC_DIR)
diff --git a/backend/documentation/how-to-generate-documentation.txt
b/backend/documentation/how-to-generate-documentation.txt
deleted file mode 100644
index 3af5b30..0000000
--- a/backend/documentation/how-to-generate-documentation.txt
+++ /dev/null
@@ -1,10 +0,0 @@
-Documentation of python:
- # epydoc needs to be installed, it needs texlive, ouch :-(
- # graphviz needs to be installed.
- # In the Copr git repo checkout, in documentation/ directory:
- git rm -rf python-doc
- make python
- git add python-doc
- rm -rf build
- # update python-doc.readme
- git commit -m 'Updating python documentation.' .