tajo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Tajo Wiki] Update of "HowToWriteUserDocumentations" by HyunsikChoi
Date Fri, 07 Mar 2014 03:10:18 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Tajo Wiki" for change notification.

The "HowToWriteUserDocumentations" page has been changed by HyunsikChoi:
https://wiki.apache.org/tajo/HowToWriteUserDocumentations?action=diff&rev1=3&rev2=4

  
  == Generating user documentations form ReStructuredFormat files ==
  
+ === Prerequisites ===
+ You should prepare the followings:
+  * sphinx
+  * pip
+  * sphinx-rtd-theme (theme we used)
+ 
+ 
+ {{{
+  $ sudo easy_install sphinx
+  $ sudo easy_install pip
+  $ sudo pip install sphinx_rtd_theme
+ }}}
+ 
+ === Generating documentations ===
+ 
- Simply, you can generate HTML files with ''make'' utility as follow.
+ Then, you can generate HTML files with ''make'' utility as follow.
  {{{
    $ cd tajo-docs
    $ make clean html
@@ -71, +86 @@

  $ make clean singlehtml
  }}}
  
+ === FAQ ===
+ ==== ValueError: unknown locale: UTF-8 ====
+ You can meet {{{ValueError: unknown locale: UTF-8}}} error especially in Mac OS X.
+ {{{
+ Traceback (most recent call last):
+ File "/opt/local/bin/hg", line 25, in 
+ mercurial.util.set_binary(fp)
+ File "/opt/local/lib/python2.5/site-packages/mercurial/demandimport.py", line 75, in __getattribute__
+ self._load()
+ File "/opt/local/lib/python2.5/site-packages/mercurial/demandimport.py", line 47, in _load
+ mod = _origimport(head, globals, locals)
+ File "/opt/local/lib/python2.5/site-packages/mercurial/util.py", line 93, in 
+ _encoding = locale.getlocale()[1]
+ File "/opt/local/Library/Frameworks/Python.framework/Versions/2.5/lib/python2.5/locale.py",
line 462, in getlocale
+ return _parse_localename(localename)
+ File "/opt/local/Library/Frameworks/Python.framework/Versions/2.5/lib/python2.5/locale.py",
line 375, in _parse_localename
+ raise ValueError, 'unknown locale: %s' % localename
+ ValueError: unknown locale: UTF-8
+ }}}
+ 
+ In order to solve the problem, you should set two environment variables in your {{{${HOME}/.profile}}}
or {{{${HOME}/.bashrc}}}.
+ {{{
+ export LC_ALL=en_US.UTF-8
+ export LANG=en_US.UTF-8
+ }}}
+ 
  == How to update user documentations in Tajo site ==
  ||Note that this update is only available for Tajo PMC and committers.||
  

Mime
View raw message