Skip to content
This repository has been archived by the owner on Aug 30, 2023. It is now read-only.

Commit

Permalink
Describe artifacts in the documentation
Browse files Browse the repository at this point in the history
The description of libraries with appropriate links were added to
artifacts.md page.

Also, to render MD tables, "sphinx-markdown-tables" extension is added
to sphinx's configuration.

#146
  • Loading branch information
extsoft committed Jan 3, 2019
1 parent 3653b68 commit 7ff9bb3
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 19 deletions.
16 changes: 0 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,6 @@ Please read the users documentation on [http://sunshine.tatools.org](http://suns
[![Rultor.com](http://www.rultor.com/b/tatools/sunshine)](http://www.rultor.com/p/tatools/sunshine)


Tests runners
-------------

| Component | Dependency | Verified on | Tests runner class |
| --------------- | :----------: | ----------- | ------------------ |
| sunshine-testng | [![Maven Central](https://img.shields.io/maven-central/v/org.tatools/sunshine-testng.svg)](https://maven-badges.herokuapp.com/maven-central/org.tatools/sunshine-testng) | [TestNG](http://testng.org) `6.11` | [`org.tatools.sunshine.testng.Sunshine`](sunshine-testng/src/main/java/org/tatools/sunshine/testng/Sunshine.java) |
| sunshine-junit4 | [![Maven Central](https://img.shields.io/maven-central/v/org.tatools/sunshine-junit4.svg)](https://maven-badges.herokuapp.com/maven-central/org.tatools/sunshine-junit4) | [JUnit4](http://junit.org/junit4) `4.11` | [`org.tatools.sunshine.junit4.Sunshine`](sunshine-junit4/src/main/java/org/tatools/sunshine/junit4/Sunshine.java) |

For `version` <= `0.3.0`

| Component | Dependency | Verified on | Tests runner class |
| --------------- | :----------: | ----------- | ------------------ |
| sunshine-testng | [![Maven Central](https://img.shields.io/maven-central/v/io.github.tatools/sunshine-testng.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.tatools/sunshine-testng) | [TestNG](http://testng.org) `6.11` | [`io.github.tatools.sunshine.testng.Sunshine`](sunshine-testng/src/main/java/io/github/tatools/sunshine/testng/Sunshine.java) |
| sunshine-junit4 | [![Maven Central](https://img.shields.io/maven-central/v/io.github.tatools/sunshine-junit4.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.tatools/sunshine-junit4) | [JUnit4](http://junit.org/junit4) `4.11` | [`io.github.tatools.sunshine.junit4.Sunshine`](sunshine-junit4/src/main/java/io/github/tatools/sunshine/junit4/Sunshine.java) |


How to customize Sunshine?
==========================
Filter tests to be run
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
'sphinx.ext.githubpages',
'sphinx.ext.autosectionlabel',
'recommonmark',
'sphinx_markdown_tables',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
16 changes: 13 additions & 3 deletions docs/md/artifacts.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
# Artifacts

https://www.javadoc.io/doc/io.github.tatools/sunshine-core
Sunshine consists of 3 libraries
- `sunshine-core` provides interfaces and common implementations
- `sunshine-junit4` wraps JUnit4 to allow the creation of [entry points](entry-points.md)
- `sunshine-testng` wraps TestNG to allow the creation of [entry points](entry-points.md)

https://www.javadoc.io/doc/io.github.tatools/sunshine-junit4
Artifact|`sunshine-testng`|`sunshine-junit4`|`sunshine-core`
---|---|---|---
Library|[![](https://img.shields.io/maven-central/v/org.tatools/sunshine-testng.svg)](https://search.maven.org/search?q=g:%22org.tatools%22%20AND%20a:%22sunshine-testng%22)|[![](https://img.shields.io/maven-central/v/org.tatools/sunshine-junit4.svg)](https://search.maven.org/search?q=g:%22org.tatools%22%20AND%20a:%22sunshine-junit4%22)|[![](https://img.shields.io/maven-central/v/org.tatools/sunshine-core.svg)](https://search.maven.org/search?q=g:%22org.tatools%22%20AND%20a:%22sunshine-core%22)
Javadoc|[![](https://www.javadoc.io/badge/org.tatools/sunshine-testng.svg)](https://www.javadoc.io/doc/org.tatools/sunshine-testng)|[![](https://www.javadoc.io/badge/org.tatools/sunshine-junit4.svg)](https://www.javadoc.io/doc/org.tatools/sunshine-junit4)|[![](https://www.javadoc.io/badge/org.tatools/sunshine-core.svg)](https://www.javadoc.io/doc/org.tatools/sunshine-core)

https://www.javadoc.io/doc/io.github.tatools/sunshine-testng

`sunshine-junit4` was tested on `4.11` version of JUnit4 and `sunshine-testng` on `6.11` version of TestNG.

Since `0.4.x` version Sunshine uses `org.tatools` group ID. If you need the earlier version
please use `io.github.tatools` instead.
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
sphinx==1.8.2
# recommonmark==0.5.0.dev0
git+https://github.com/rtfd/recommonmark
sphinx-markdown-tables==0.0.9

0 comments on commit 7ff9bb3

Please sign in to comment.