com.twosigma.znai:znai-sphinx

Rich documentation generator (markdown and java based)

License	Apache License, Version 2.0
GroupId	com.twosigma.znai
ArtifactId	znai-sphinx
Last Version	1.29
Release Date	Feb 6, 2020
Type	jar
Description	Rich documentation generator (markdown and java based)

Download znai-sphinx

Filename	Size
znai-sphinx-1.29.pom
znai-sphinx-1.29.jar	22 KB
znai-sphinx-1.29-sources.jar	16 KB
znai-sphinx-1.29-javadoc.jar	446 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.twosigma.znai/znai-sphinx/ -->
<dependency>
    <groupId>com.twosigma.znai</groupId>
    <artifactId>znai-sphinx</artifactId>
    <version>1.29</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.twosigma.znai/znai-sphinx/
implementation 'com.twosigma.znai:znai-sphinx:1.29'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.twosigma.znai/znai-sphinx/
implementation ("com.twosigma.znai:znai-sphinx:1.29")

Apache Buildr

'com.twosigma.znai:znai-sphinx:jar:1.29'

Apache Ivy

<dependency org="com.twosigma.znai" name="znai-sphinx" rev="1.29">
  <artifact name="znai-sphinx" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.twosigma.znai', module='znai-sphinx', version='1.29')
)

Scala SBT

libraryDependencies += "com.twosigma.znai" % "znai-sphinx" % "1.29"

Leiningen

[com.twosigma.znai/znai-sphinx "1.29"]

Dependencies

compile (2)

Group / Artifact	Type	Version
com.twosigma.znai : znai-core	jar	1.29
org.apache.commons : commons-lang3	jar	3.5

test (3)

Group / Artifact	Type	Version
junit : junit	jar	4.12
com.twosigma.znai : znai-core	test-jar	1.29
com.twosigma.webtau : webtau-core-groovy	jar	1.16

Project Modules

There are no modules declared in this project.

Znai

Znai transforms Markdown files into rich, well-structured documentation served in a web front-end built on React. It provides many custom add-ons that supercharge basic generated docs with advanced layout features, dynamic references to code and test artifacts, and many visual and functional enhancements.

User guide: https://testingisdocumenting.org/znai/

Developer Setup

Build requires "dot" from the graphviz project to be available on the $PATH.

MacOS

brew install graphviz

Ubuntu/Debian

sudo apt-get install graphviz

Two Sigma

Versions

Version
1.29 Feb 6, 2020
1.27 Feb 6, 2020
1.26 Feb 5, 2020
1.25 Feb 5, 2020
1.24 Feb 5, 2020
1.22 Jan 17, 2020
1.21 Nov 26, 2019
1.20 Oct 3, 2019
1.19 Oct 3, 2019
1.18 Oct 1, 2019
0.16 Aug 10, 2019