Skip to content

Commit ed185eb

Browse files
authored
(docs) minor documentation polishing
1 parent 39c2d4e commit ed185eb

File tree

4 files changed

+8
-4
lines changed

4 files changed

+8
-4
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
[![Static Badge](https://img.shields.io/badge/API-Documentation-e?logo=bookstack&logoColor=white&link=https%3A%2F%2Famkrajewski.github.io%2Fnimplex%2F)](https://nimplex.phaseslab.org)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
55
<a href="https://nimble.directory/pkg/nimplex"><img src="https://raw.githubusercontent.com/amkrajewski/nimble-badge/master/badges/nimplex.svg" alt="Nimble Package" height="20"></a>
6-
[![Arxiv](https://img.shields.io/badge/arXiv-2402.03528-8F1515?style=flat&logo=arxiv&logoColor=red)](https://doi.org/10.48550/arXiv.2402.03528) **(In-Press at npj Unconventional Computing)**
6+
[![Arxiv](https://img.shields.io/badge/arXiv-2402.03528-8F1515?style=flat&logo=arxiv&logoColor=red)](https://doi.org/10.48550/arXiv.2402.03528)
7+
8+
**(In-Press at npj Unconventional Computing)**
79

810
[![(Linux) Grid, Graph, and CLI Tests](https://github.com/amkrajewski/nimplex/actions/workflows/testingOnPush_Linux.yaml/badge.svg)](https://github.com/amkrajewski/nimplex/actions/workflows/testingOnPush_Linux.yaml)
911
[![(MaxOS) Grid, Graph, and CLI Tests](https://github.com/amkrajewski/nimplex/actions/workflows/testingOnPush_Apple.yaml/badge.svg)](https://github.com/amkrajewski/nimplex/actions/workflows/testingOnPush_Apple.yaml)

docs/docs.nim

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
##
33
## Such spaces are considered when an entity can be split into a set of distinct components (a composition), and they play a critical role in many disciplines of science, engineering, and mathematics. For instance, in materials science, chemical composition refers to the way a material (or, more generally, matter) is split into distinct components, such as chemical elements, based on considerations such as fraction of atoms, occupied volume, or contributed mass. And in economics, portfolio composition may refer to how finite capital is split across vehicles, such as cash, equity instruments, real estate, and commodities, based on their monetary value.
44
##
5-
## **Navigation:** [**nimplex**](nimplex.html) (core library) | [docs/**changelog**](docs/changelog.html) | [utils/**plotting**](utils/plotting.html) | [utils/**stitching**](utils/stitching.html) |
5+
## **Navigation:** [**nimplex**](nimplex.html) (core library) | [docs/changelog](docs/changelog.html) | [utils/plotting](utils/plotting.html) | [utils/stitching](utils/stitching.html) |
66
##
77
## .. figure:: https://img.shields.io/badge/License-MIT-yellow.svg
88
## :alt: MIT License

docs/getChangelog.nim

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ let
1818
data = parseJson(response.body)
1919

2020
if changelogType == "md":
21-
targetFile.writeLine("**Navigation:** [nimplex](../nimplex.html) (core library) | [docs/changelog](changelog.html) | [utils/plotting](../utils/plotting.html)\n")
21+
targetFile.writeLine("**Navigation:** [nimplex](../nimplex.html) (core library) | [docs/changelog](changelog.html) | [utils/plotting](../utils/plotting.html) | [utils/stitching](../utils/stitching.html)\n")
2222
elif changelogType == "nim":
23-
targetFile.writeLine("## **Navigation:** [nimplex](../nimplex.html) (core library) | [docs/changelog](changelog.html) | [utils/plotting](../utils/plotting.html)\n")
23+
targetFile.writeLine("## **Navigation:** [nimplex](../nimplex.html) (core library) | [docs/changelog](changelog.html) | [utils/plotting](../utils/plotting.html) | [utils/stitching](../utils/stitching.html)\n")
2424

2525
for d in data:
2626
let

utils/stitching.nim

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ when appType == "lib" and not defined(nimdoc):
1919
##
2020
## **Navigation:** [nimplex](../nimplex.html) (core library) | [docs/changelog](../docs/changelog.html) | [utils/plotting](plotting.html) | [utils/stitching](stitching.html)
2121
##
22+
## .. figure:: ../assets/Fig4.png
23+
## :alt: Simplex Graph Complex
2224

2325

2426
func generateAlphabetSequence(length: int): seq[string] =

0 commit comments

Comments
 (0)