Merge pull request #67 from GeorgKreuzmayr/feature/readthedocs_update

Add link to API documentation on readthedocs
TNG · Mar 23, 2021 · ab6b890 · ab6b890
2 parents 06f1f94 + 2ff2096
commit ab6b890
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 42 deletions.
diff --git a/documentation/docs/additional.md b/documentation/docs/additional.md
@@ -0,0 +1,13 @@
+![ArchUnitNET][archunit-logo]
+[archunit-logo]: img/ArchUnitNET-Logo.svg
+
+# Additional
+
+## API
+
+[Here](https://tng.github.io/ArchUnitNET/annotated.html) you can find the API of ArchUnitNET.
+
+## Limitations
+
+* [Debug Artifacts](limitations/debug_artifacts.md)
+* [Constant Fields](limitations/constant_fields.md)
diff --git a/documentation/docs/api.md b/documentation/docs/api.md
diff --git a/documentation/docs/guide.md b/documentation/docs/guide.md
@@ -176,6 +176,6 @@ Assert.True(checkedRule);
 ```
 
 ## 5. Further Reading and Examples
-A complete overview of all available methods can be found [here](api.md).
+A complete overview of all available methods can be found [here](additional.md).
 
 Check out example code on [Github](https://github.com/TNG/ArchUnitNET/tree/master/ExampleTest "ExampleTests").
diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml
@@ -5,7 +5,7 @@ docs_dir: docs
 nav:
     - About: index.md
     - User Guide: guide.md
-    - API: api.md
+    - Additional: additional.md
     - Contribution: contributing.md
     - License: license.md