sqoop-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jar...@apache.org
Subject git commit: SQOOP-492: Implement a documentation system for Sqoop2
Date Wed, 14 Nov 2012 20:09:56 GMT
Updated Branches:
  refs/heads/sqoop2 2c9a4eb46 -> c39c7c9f1


SQOOP-492: Implement a documentation system for Sqoop2

(Kathleen Ting via Jarek Jarcec Cecho)


Project: http://git-wip-us.apache.org/repos/asf/sqoop/repo
Commit: http://git-wip-us.apache.org/repos/asf/sqoop/commit/c39c7c9f
Tree: http://git-wip-us.apache.org/repos/asf/sqoop/tree/c39c7c9f
Diff: http://git-wip-us.apache.org/repos/asf/sqoop/diff/c39c7c9f

Branch: refs/heads/sqoop2
Commit: c39c7c9f1ac45c892a22e8c83240524a3b1f993c
Parents: 2c9a4eb
Author: Jarek Jarcec Cecho <jarcec@apache.org>
Authored: Wed Nov 14 12:08:58 2012 -0800
Committer: Jarek Jarcec Cecho <jarcec@apache.org>
Committed: Wed Nov 14 12:08:58 2012 -0800

----------------------------------------------------------------------
 docs/pom.xml                                 |   85 ++++++++++++---
 docs/src/site/sphinx/SqoopDeveloperGuide.rst |   22 ++++
 docs/src/site/sphinx/SqoopUserGuide.rst      |   22 ++++
 docs/src/site/sphinx/conf.py                 |  120 +++++++++++++++++++++
 docs/src/site/sphinx/index.rst               |   55 ++++++++++
 docs/src/site/sphinx/sqoop-logo.png          |  Bin 0 -> 1877 bytes
 6 files changed, 291 insertions(+), 13 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/sqoop/blob/c39c7c9f/docs/pom.xml
----------------------------------------------------------------------
diff --git a/docs/pom.xml b/docs/pom.xml
index 8f2b4cf..cbe5053 100644
--- a/docs/pom.xml
+++ b/docs/pom.xml
@@ -30,18 +30,77 @@ limitations under the License.
   <groupId>org.apache.sqoop</groupId>
   <artifactId>sqoop-docs</artifactId>
   <name>Sqoop Documentation</name>
-  <packaging>war</packaging>
-
-  <dependencies>
-    <dependency>
-      <groupId>org.apache.sqoop</groupId>
-      <artifactId>sqoop-core</artifactId>
-      <version>2.0.0-SNAPSHOT</version>
-    </dependency>
-  </dependencies>
-  
-  <build>
-    <finalName>sqoopdocs</finalName>
-  </build>
 
+
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-project-info-reports-plugin</artifactId>
+        <version>2.4</version>
+        <reportSets>
+          <reportSet>
+            <reports></reports>
+          </reportSet>
+        </reportSets>
+      </plugin>
+      <plugin>
+        <groupId>org.tomdz.maven</groupId>
+        <artifactId>sphinx-maven-plugin</artifactId>
+        <version>1.0.2</version>
+      </plugin>
+    </plugins>
+  </reporting>
+  <profiles>
+    <profile>
+      <id>maven-3</id>
+      <activation>
+        <file>
+           <!--  This employs that the basedir expression is only recognized by Maven
3.x (see MNG-2363) -->
+          <exists>${basedir}</exists>
+        </file>
+      </activation>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-site-plugin</artifactId>
+            <version>3.0-beta-3</version>
+            <configuration>
+              <reportPlugins>
+                <plugin>
+                  <groupId>org.apache.maven.plugins</groupId>
+                  <artifactId>maven-project-info-reports-plugin</artifactId>
+                  <version>2.2</version>
+                  <reportSets>
+                    <reportSet>
+                      <reports></reports>
+                    </reportSet>
+                  </reportSets>
+                </plugin>
+                <plugin>
+                  <groupId>org.tomdz.maven</groupId>
+                  <artifactId>sphinx-maven-plugin</artifactId>
+                  <version>1.0.2</version>
+                </plugin>
+              </reportPlugins>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+
+  <pluginRepositories>
+    <pluginRepository>
+        <id>oss.sonatype.org</id>
+        <url>https://oss.sonatype.org/content/groups/public</url>
+        <releases>
+          <enabled>true</enabled>
+        </releases>
+        <snapshots>
+          <enabled>false</enabled>
+        </snapshots>
+    </pluginRepository>
+  </pluginRepositories>
 </project>

http://git-wip-us.apache.org/repos/asf/sqoop/blob/c39c7c9f/docs/src/site/sphinx/SqoopDeveloperGuide.rst
----------------------------------------------------------------------
diff --git a/docs/src/site/sphinx/SqoopDeveloperGuide.rst b/docs/src/site/sphinx/SqoopDeveloperGuide.rst
new file mode 100644
index 0000000..d39ba0f
--- /dev/null
+++ b/docs/src/site/sphinx/SqoopDeveloperGuide.rst
@@ -0,0 +1,22 @@
+.. Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+=========================
+Sqoop Developer Guide
+=========================
+
+
+Content to come.

http://git-wip-us.apache.org/repos/asf/sqoop/blob/c39c7c9f/docs/src/site/sphinx/SqoopUserGuide.rst
----------------------------------------------------------------------
diff --git a/docs/src/site/sphinx/SqoopUserGuide.rst b/docs/src/site/sphinx/SqoopUserGuide.rst
new file mode 100644
index 0000000..96d48e9
--- /dev/null
+++ b/docs/src/site/sphinx/SqoopUserGuide.rst
@@ -0,0 +1,22 @@
+.. Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+=========================
+Sqoop User Guide
+=========================
+
+
+Content to come.

http://git-wip-us.apache.org/repos/asf/sqoop/blob/c39c7c9f/docs/src/site/sphinx/conf.py
----------------------------------------------------------------------
diff --git a/docs/src/site/sphinx/conf.py b/docs/src/site/sphinx/conf.py
new file mode 100644
index 0000000..642d065
--- /dev/null
+++ b/docs/src/site/sphinx/conf.py
@@ -0,0 +1,120 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+
+# -*- coding: utf-8 -*-
+
+import sys
+import os
+
+# eventlet/gevent should not monkey patch anything.
+os.environ["GEVENT_NOPATCH"] = "yes"
+os.environ["EVENTLET_NOPATCH"] = "yes"
+#os.environ["CELERY_LOADER"] = "default"
+
+this = os.path.dirname(os.path.abspath(__file__))
+
+# If your extensions are in another directory, add it here. If the directory
+# is relative to the documentation root, use os.path.abspath to make it
+# absolute, like shown here.
+sys.path.append(os.path.join(os.pardir, "tests"))
+sys.path.append(os.path.join(this, "_ext"))
+#import celery
+
+
+
+# General configuration
+# ---------------------
+
+extensions = [
+  'sphinx.ext.autodoc',
+  'sphinx.ext.coverage',
+  'sphinx.ext.pngmath',
+  'sphinx.ext.intersphinx',
+]
+
+html_show_sphinx = False
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['.templates', 'themes']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Apache Sqoop'
+copyright = '2009-2012 The Apache Software Foundation'
+
+keep_warnings = True
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+#version = ".".join(map(str, celery.VERSION[0:2]))
+# The full version, including alpha/beta/rc tags.
+#release = celery.__version__
+
+exclude_trees = ['.build']
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+add_function_parentheses = True
+
+#intersphinx_mapping = {
+#  "http://docs.python.org/dev": None,
+#  "http://kombu.readthedocs.org/en/latest/": None,
+#  "http://django-celery.readthedocs.org/en/latest": None,
+#}
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'trac'
+highlight_language = 'none'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path = ['../resources/images']
+
+html_logo = 'sqoop-logo.png'
+
+html_use_smartypants = True
+
+# If false, no module index is generated.
+html_use_modindex = True
+
+# If false, no index is generated.
+html_use_index = True
+
+#html_theme = 'default'
+
+html_sidebars = {
+  '**': ['localtoc.html', 'relations.html', 'sourcelink.html'],
+}
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'haiku'
+
+# 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
+# documentation.
+#html_theme_options = {
+#}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = ['themes']

http://git-wip-us.apache.org/repos/asf/sqoop/blob/c39c7c9f/docs/src/site/sphinx/index.rst
----------------------------------------------------------------------
diff --git a/docs/src/site/sphinx/index.rst b/docs/src/site/sphinx/index.rst
new file mode 100644
index 0000000..b9a6e2c
--- /dev/null
+++ b/docs/src/site/sphinx/index.rst
@@ -0,0 +1,55 @@
+.. Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+=======================================
+Apache Sqoop documentation
+=======================================
+
+Apache Sqoop is a tool designed for efficiently transferring bulk data between Apache Hadoop
and structured datastores such as relational databases.
+
+License
+-------
+
+::
+
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You 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.
+
+Overview
+--------
+
+- `Download Apache Sqoop <http://www.apache.org/dyn/closer.cgi/sqoop>`_
+- `Sqoop Wiki <https://cwiki.apache.org/confluence/display/SQOOP/Home>`_
+- `Sqoop Issue Tracking (JIRA) <https://issues.apache.org/jira/browse/SQOOP>`_
+- `Sqoop Source Code <https://git-wip-us.apache.org/repos/asf?p=sqoop.git;a=summary>`_
+
+Documentation
+-------------
+
+- `Sqoop User Guide <SqoopUserGuide.html>`_
+- `Sqoop Developer Guide <SqoopDeveloperGuide.html>`_

http://git-wip-us.apache.org/repos/asf/sqoop/blob/c39c7c9f/docs/src/site/sphinx/sqoop-logo.png
----------------------------------------------------------------------
diff --git a/docs/src/site/sphinx/sqoop-logo.png b/docs/src/site/sphinx/sqoop-logo.png
new file mode 100644
index 0000000..406ca92
Binary files /dev/null and b/docs/src/site/sphinx/sqoop-logo.png differ


Mime
View raw message