Remove old sphinx doc

This commit is contained in:
Lee moon soo 2015-03-30 07:03:27 +09:00
parent be06c43440
commit 92eb87fcad
12 changed files with 0 additions and 611 deletions

View file

@ -1,174 +0,0 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = target
SOURCEDIR = src/main/sphinx
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -W -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

View file

@ -1,24 +0,0 @@
# Zeppelin documentation
Build Zeppelin documentation
## Get Sphinx-doc
- Install [Sphinx](http://sphinx-doc.org/install.html)
## Build
```mvn package```
Or
```make html```
Sphinx will create the folder "targert".
### Build failed
- make: sphinx-build: No such file or directory
```
Make sure sphinx is correctly installed
Check the sphinx app name (can be sphinx-build27, in that case make a symbolic link)
```
- ValueError: unknown locale: UTF-8
````
export LC_ALL=en_US.UTF-8
export LANG=en_US.UTF-8
```

View file

@ -1,87 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>zeppelin</artifactId>
<groupId>com.nflabs.zeppelin</groupId>
<version>0.5.0-SNAPSHOT</version>
</parent>
<groupId>com.nflabs.zeppelin</groupId>
<artifactId>zeppelin-api-ui</artifactId>
<packaging>war</packaging>
<version>0.5.0-SNAPSHOT</version>
<name>Zeppelin: Documentation</name>
<url>http://www.nflabs.com</url>
<!--
Genarate HTML docs quickly while developing:
- brew install python
- pip install sphinx
-->
<build>
<finalName>zeppelin-api-ui</finalName>
<pluginManagement>
<plugins>
<plugin>
<groupId>com.mycila</groupId>
<artifactId>license-maven-plugin</artifactId>
<configuration>
<excludes combine.children="append">
<exclude>**/*.conf</exclude>
<exclude>**/*.css_t</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</pluginManagement>
<plugins>
<!-- Swagger ui -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<configuration>
<failOnMissingWebXml>false</failOnMissingWebXml>
<webResources>
<resource>
<directory>src/main/swagger</directory>
</resource>
</webResources>
</configuration>
</plugin>
<!-- Sphinx -->
<plugin>
<groupId>org.tomdz.maven</groupId>
<artifactId>sphinx-maven-plugin</artifactId>
<configuration>
<fork>true</fork>
<force>true</force>
<warningsAsErrors>true</warningsAsErrors>
<sourceDirectory>${project.basedir}/src/main/sphinx</sourceDirectory>
<outputDirectory>${project.build.directory}/html</outputDirectory>
</configuration>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<version>2.7</version>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
</plugins>
</build>
</project>

View file

@ -1,21 +0,0 @@
.. Zeppelin documentation master file, created by
sphinx-quickstart on Wed Jan 29 17:19:36 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Zeppelin documentation
====================================
.. toctree::
:maxdepth: 4
:numbered: 2
:titlesonly:
installation
Link
====================================
.. toctree::
:maxdepth: 1
* :ref:`search`

View file

@ -1,8 +0,0 @@
************
Installation
************
.. toctree::
:maxdepth: 1
installation/install

View file

@ -1,101 +0,0 @@
=================
Install Zeppelin
=================
Instructions for the Impatient
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Install Zeppelin in local mode
.. code-block:: bash
# this scripts install hadoop and zeppelin in current directory and start zeppelin in local mode
# download and unarchive hadoop distribution package
curl -O http://apache.mirror.cdnetworks.com/hadoop/common/hadoop-1.2.1/hadoop-1.2.1-bin.tar.gz
tar -xzf hadoop-1.2.1-bin.tar.gz
# download zeppelin and unarchive
curl -O https://s3-ap-northeast-1.amazonaws.com/zeppel.in/zeppelin-0.3.0.tar.gz
tar -xzf zeppelin-0.3.0.tar.gz
# set HADOOP_HOME
echo "export HADOOP_HOME=`pwd`/hadoop-1.2.1" >> zeppelin-0.3.0/conf/zeppelin-env.sh
# start zeppelin
./zeppelin-0.3.0/bin/zeppelin-daemon.sh start
You can access Zeppelin with browser http://localhost:8080
Install
^^^^^^^
Configuring Zeppelin with existing hadoop cluster, refer this section.
Prerequisites
-------------
Java 1.6 or Later
Apache Hadoop (Standalone mode)
Download
To get Zeppelin distribution, download a recent release.
Install
-------
Unpack the downloaded Zeppelin distribution.
Configure
---------
Configuration can be done by both environment variable and java properties. If both defined, environment vaiable is used.
========================= ======================= ============================== ===========
zepplin-env.sh zepplin-site.xml Default value Description
========================= ======================= ============================== ===========
ZEPPELIN_HOME Zeppelin Home directory
ZEPPELIN_PORT zeppelin.server.port 8080 Zeppelin server port
ZEPPELIN_JOB_DIR zeppelin.job.dir jobs Zeppelin persist/load session in this directory. Can be a path or a URI. location on HDFS supported
ZEPPELIN_ZAN_REPO zeppelin.zan.repo https://github.com/NFLabs/zan Remote ZAN repository URL
ZEPPELIN_ZAN_LOCAL_REPO zeppelin.zan.localrepo zan-repo Zeppelin library local repository. Local filesystem path
ZEPPELIN_ZAN_SHARED_REPO zeppelin.zan.sharedrepo Zeppelin library shared repository. Location on HDFS. Usufull when your backend (eg. hiveserver) is not running on the sam machine and want to use zeppelin library with resource file(eg. in hive 'ADD FILE 'path'). So your backend can get resource file from shared repository.
ZEPPELIN_DRIVERS zeppelin.drivers hive:hive2://,exec:exec:// Comma separated list of [Name]:[Connection URI]
ZEPPELIN_DRIVER_DIR zeppelin.driver.dir drivers Zeppelin driver directory.
========================= ======================= ============================== ===========
Configuring with existing Hive
-------------------------------
If you have hive already installed in your hadoop cluster, just run hive server and make Zeppelin to connect it. There're two different version of hive servers, Hive Server1, Hive Server2. Make sure you have Hive server running.
And then, add connection uri in zeppelin.drivers at zeppelin-site.xml If you have Hive Server 1 installed and running on host hiveserver1Address on port 10000, configuration property can be
.. code-block:: bash
<property>
<name>zeppelin.drivers</name>
<value>hive:hive://hiveserver1Address:10000/default,exec:exec://</value>
<description>Comma separated driver configurations uri. </description>
</property>
If Hive Server 2 installed and running on host hiveserver2Address on port 10000, configuration will be
.. code-block:: bash
<property>
<name>zeppelin.drivers</name>
<value>hive:hive2://hiveserver2Address:10000/default,exec:exec://</value>
<description>Comma separated driver configurations uri. </description>
</property>
Start/Stop
^^^^^^^^^^
**Start Zeppelin**
.. code-block:: bash
bin/zeppelin-daemon.sh start
After successful start, visit http://localhost:8080 with your web browser
**Stop Zeppelin**
.. code-block:: bash
bin/zeppelin-daemon.sh stop

View file

@ -1,38 +0,0 @@
{%- extends 'basic/layout.html' %}
{% block relbar1 %}{% endblock %}
{% block relbar2 %}{% endblock %}
{% macro nav() %}
<p class="nav">
<span class="left">
{%- if prev %}
&laquo; <a href="{{ prev.link|e }}">{{ prev.title }}</a>
{%- else %}
&nbsp;
{%- endif %}
</span>
<span class="right">
{%- if next %}
<a href="{{ next.link|e }}">{{ next.title }}</a> &raquo;
{%- endif %}
</span>
</p>
{% endmacro %}
{% block content %}
<div class="header">
<h1 class="heading"><a href="{{ pathto('index') }}">
<span>{{ shorttitle|e }}</span></a></h1>
<h2 class="heading"><span>{{ title|striptags|e }}</span></h2>
</div>
<div class="topnav">
{{ nav() }}
</div>
<div class="content">
{% block body %}{% endblock %}
</div>
<div class="bottomnav">
{{ nav() }}
</div>
{% endblock %}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 974 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 109 B

View file

@ -1,132 +0,0 @@
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@import url("haiku.css");
@import url(http://fonts.googleapis.com/css?family=Anonymous+Pro);
@import url(http://fonts.googleapis.com/css?family=Open+Sans:400italic,600italic,700italic,400,600,700);
html {
background: #fff;
-webkit-font-smoothing: antialiased;
}
body {
/* font-family: 'Helvetica Neue', Helvetica, Arial, 'lucida grande', tahoma, verdana, arial, sans-serif;*/
font-family: 'Open Sans', sans-serif;
color: #222222;
}
div.header {
background-color: rgb(48, 113, 169);
background-image: url(presto.png);
background-position: 36px 50%;
background-repeat: no-repeat;
background-size: 57px 50px;
padding: 10px 40px 20px 120px;
color: #fff !important;
}
div.header h1 a {
color: #fff !important;
}
div.header h2 {
color: rgb(184, 184, 185);
}
.nav .right {
float: right;
text-align: right;
}
.highlight pre {
background-color:white;
font-family: 'Anonymous Pro', sans-serif;
}
pre {
padding: 0.8em;
border: 0;
}
div.topnav {
background: #eeeeee;
}
div.topnav,
div.bottomnav {
padding: 10px 0;
}
div.topnav p,
div.bottomnav p {
font-size: 1.0em;
margin: 0 40px;
text-align: left;
}
div.header h1 {
font-size: 1.8em;
}
h1 {
font-size: 1.5em;
}
h2 {
font-size: 1.4em;
}
h3 {
font-size: 1.3em;
}
h4 {
font-size: 1.2em;
}
div.content {
font-size: 1.0em;
}
div.content ul > li {
background-image: url(bullet.png);
}
div.admonition {
border-radius: 3px;
border-style: solid;
}
div.note {
background-color: #f5f5ff
}
tt {
font-family: Consolas, 'Liberation Mono', Courier, monospace;
font-size: 0.9em;
}
tt.descname {
font-size: 1.1em;
}
tt.docutils.literal {
margin: 0 2px;
padding: 0 5px;
border: 1px solid #ddd;
background-color: #f8f8f8;
border-radius: 3px;
white-space: nowrap;
}

View file

@ -1,26 +0,0 @@
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
[theme]
inherit = haiku
stylesheet = zeppelin.css
[options]
bodyfont = 'Open Sans', sans-serif
full_logo = false
textcolor = #ecf2fc
headingcolor = #374665
linkcolor = #3b5998
visitedlinkcolor = #3b5998
hoverlinkcolor = #3b5998