Sphinx-generated docs for Zeppelin project by bzz · Pull Request #11 · ZEPL/zeppelin

bzz · 2013-12-05T07:26:43Z

It's a part (or pre-request) of ZEPPELIN-64 but deals with how do we manage the project documentation itself, which should be close to code (and evolve together)

The idea is: to update docs you

build docs .rst -> html as a part of the build
then copy the result to GithubPages

Leemoonsoo · 2013-12-05T08:59:12Z

i tried

cd zeppelin-docs
mvn package -X

and got this error

...
...
[DEBUG] /bin/sh -c cd /Users/moon/Projects/zeppelin/zeppelin-docs && /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home/bin/java org.tomdz.maven.sphinx.SphinxRunner --sphinxSourceDirectory /Users/moon/Projects/zeppelin/zeppelin-docs/target/sphinx -v -W -a -E -b html -n /Users/moon/Projects/zeppelin/zeppelin-docs/src/main/sphinx /Users/moon/Projects/zeppelin/zeppelin-docs/target/html
[INFO] Running Sphinx v1.1.3
[ERROR] 
[ERROR] Extension error:
[ERROR] Could not import extension download (exception: No module named download)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 25.013s
[INFO] Finished at: Thu Dec 05 17:56:19 KST 2013
[INFO] Final Memory: 8M/81M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.tomdz.maven:sphinx-maven-plugin:1.0.3:generate (default) on project zeppelin-docs: Failed to run the report: Sphinx report generation failed -> [Help 1]
org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.tomdz.maven:sphinx-maven-plugin:1.0.3:generate (default) on project zeppelin-docs: Failed to run the report
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:216)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:153)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:145)
    at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:84)
    at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:59)
    at org.apache.maven.lifecycle.internal.LifecycleStarter.singleThreadedBuild(LifecycleStarter.java:183)
    at org.apache.maven.lifecycle.internal.LifecycleStarter.execute(LifecycleStarter.java:161)
    at org.apache.maven.DefaultMaven.doExecute(DefaultMaven.java:318)
    at org.apache.maven.DefaultMaven.execute(DefaultMaven.java:153)
    at org.apache.maven.cli.MavenCli.execute(MavenCli.java:555)
    at org.apache.maven.cli.MavenCli.doMain(MavenCli.java:214)
    at org.apache.maven.cli.MavenCli.main(MavenCli.java:158)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
    at java.lang.reflect.Method.invoke(Method.java:597)
    at org.codehaus.plexus.classworlds.launcher.Launcher.launchEnhanced(Launcher.java:290)
    at org.codehaus.plexus.classworlds.launcher.Launcher.launch(Launcher.java:230)
    at org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode(Launcher.java:414)
    at org.codehaus.plexus.classworlds.launcher.Launcher.main(Launcher.java:357)
Caused by: org.apache.maven.plugin.MojoExecutionException: Failed to run the report
    at org.tomdz.maven.sphinx.SphinxMojo.execute(SphinxMojo.java:270)
    at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo(DefaultBuildPluginManager.java:106)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:208)
    ... 19 more
Caused by: org.apache.maven.reporting.MavenReportException: Sphinx report generation failed
    at org.tomdz.maven.sphinx.SphinxMojo.runForkedSphinx(SphinxMojo.java:438)
    at org.tomdz.maven.sphinx.SphinxMojo.executeReport(SphinxMojo.java:279)
    at org.tomdz.maven.sphinx.SphinxMojo.execute(SphinxMojo.java:267)
    ... 21 more
[ERROR] 
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException

bzz · 2013-12-05T09:52:11Z

That's right actually, this PR now is more of the early-bird preview - i
just wanted to give idea of the implementation which is not finished yet.
Next time something is not finished, i'll specify that explicitly.

On Thu, Dec 5, 2013 at 5:59 PM, Lee moon soo [email protected]:

i tried

cd zeppelin-docs
mvn package -X

and got this error

...
...
[DEBUG] /bin/sh -c cd /Users/moon/Projects/zeppelin/zeppelin-docs && /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home/bin/java org.tomdz.maven.sphinx.SphinxRunner --sphinxSourceDirectory /Users/moon/Projects/zeppelin/zeppelin-docs/target/sphinx -v -W -a -E -b html -n /Users/moon/Projects/zeppelin/zeppelin-docs/src/main/sphinx /Users/moon/Projects/zeppelin/zeppelin-docs/target/html
[INFO] Running Sphinx v1.1.3
[ERROR]
[ERROR] Extension error:
[ERROR] Could not import extension download (exception: No module named download)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 25.013s
[INFO] Finished at: Thu Dec 05 17:56:19 KST 2013
[INFO] Final Memory: 8M/81M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.tomdz.maven:sphinx-maven-plugin:1.0.3:generate (default) on project zeppelin-docs: Failed to run the report: Sphinx report generation failed -> [Help 1]
org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.tomdz.maven:sphinx-maven-plugin:1.0.3:generate (default) on project zeppelin-docs: Failed to run the report
at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:216)
at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:153)
at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:145)
at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:84)
at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:59)
at org.apache.maven.lifecycle.internal.LifecycleStarter.singleThreadedBuild(LifecycleStarter.java:183)
at org.apache.maven.lifecycle.internal.LifecycleStarter.execute(LifecycleStarter.java:161)
at org.apache.maven.DefaultMaven.doExecute(DefaultMaven.java:318)
at org.apache.maven.DefaultMaven.execute(DefaultMaven.java:153)
at org.apache.maven.cli.MavenCli.execute(MavenCli.java:555)
at org.apache.maven.cli.MavenCli.doMain(MavenCli.java:214)
at org.apache.maven.cli.MavenCli.main(MavenCli.java:158)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at org.codehaus.plexus.classworlds.launcher.Launcher.launchEnhanced(Launcher.java:290)
at org.codehaus.plexus.classworlds.launcher.Launcher.launch(Launcher.java:230)
at org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode(Launcher.java:414)
at org.codehaus.plexus.classworlds.launcher.Launcher.main(Launcher.java:357)
Caused by: org.apache.maven.plugin.MojoExecutionException: Failed to run the report
at org.tomdz.maven.sphinx.SphinxMojo.execute(SphinxMojo.java:270)
at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo(DefaultBuildPluginManager.java:106)
at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:208)
... 19 more
Caused by: org.apache.maven.reporting.MavenReportException: Sphinx report generation failed
at org.tomdz.maven.sphinx.SphinxMojo.runForkedSphinx(SphinxMojo.java:438)
at org.tomdz.maven.sphinx.SphinxMojo.executeReport(SphinxMojo.java:279)
at org.tomdz.maven.sphinx.SphinxMojo.execute(SphinxMojo.java:267)
... 21 more
[ERROR]
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/11#issuecomment-29881497
.

Kind regards,
Alexander.

Initial implemetation of the Sphinx-generated docs for Zeppelin

2759454

bzz mentioned this pull request Dec 10, 2013

ZEPPELIN-64 - Migration of zeppelin-project.org to jekyll #6

Merged

6 tasks

Alexander Bezzubov added 2 commits December 11, 2013 18:27

Merge branch 'master' into adding_documentation_as_project_artifact

8e542a7

Merge branch 'master' into adding_documentation_as_project_artifact

ce7c8ce

anthonycorbacho closed this Feb 26, 2014

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sphinx-generated docs for Zeppelin project#11

Sphinx-generated docs for Zeppelin project#11
bzz wants to merge 3 commits intomasterfrom
adding_documentation_as_project_artifact

bzz commented Dec 5, 2013

Uh oh!

Leemoonsoo commented Dec 5, 2013

Uh oh!

bzz commented Dec 5, 2013

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

bzz commented Dec 5, 2013

Uh oh!

Leemoonsoo commented Dec 5, 2013

Uh oh!

bzz commented Dec 5, 2013

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants