Skip to content

Commit 74d7200

Browse files
committed
(docs) added stitching into the documentation building and navigation
1 parent 7180c7f commit 74d7200

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

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)
5+
## **Navigation:** [nimplex](nimplex.html) (core library) | [docs/changelog](docs/changelog.html) | [utils/plotting](utils/plotting.html) | [utils/stitching](utils/stitching.html)
66
##
77
## ## Quick Start
88
## If you have a GitHub account, you can get started with nimplex very quickly by just clicking the button below to launch a CodeSpaces environment with everything installed (per instructions in [Reproducible Installation](#reproducible-installation) section) and ready to go! From there, you can either use the CLI tool (as explained in [CLI](#cli) section) or import the library in Python (as explained in [Usage in Python](#usage-in-python) section) and start using it right away. Of course, it also comes with a full Nim compiler and VSCode IDE extensions for Nim, so you can effortlessly modify/extend the source code and re-compile it if you wish.

nimplex.nim

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ when appType == "lib" and not defined(nimdoc):
2929
when defined(nimdoc):
3030
# All of (comprehensive) introduction to the documentation lives in this included Nim file, while API is generated from docstrings in the code. It was moved there for cleaner code.
3131
include docs/docs
32-
# The plotting utils are not part of the core library, but are imported during documentation generation to index them as part of the library.
32+
# The plotting and stitching utils are not part of the core library, but are imported during documentation generation to index them as part of the library.
3333
import utils/plotting
34+
import utils/stitching
3435
# Check if `docs/changelog.nim` file is present in the project directory and include it in the documentation if it is.
3536
import std/os
3637
when existsFile("docs/changelog.nim"):

utils/plotting.nim

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import arraymancer/Tensor
22

33
## This submodule contains utility functions related to plotting of the compositional data.
44
##
5-
## **Navigation:** [nimplex](../nimplex.html) (core library) | [docs/changelog](../docs/changelog.html) | [utils/plotting](plotting.html)
5+
## **Navigation:** [nimplex](../nimplex.html) (core library) | [docs/changelog](../docs/changelog.html) | [utils/plotting](plotting.html) | [utils/stitching](stitching.html)
66

77
proc simplex2cartesian*(simplexPoints: Tensor[float]): Tensor[float] =
88
## Converts Arraymancer `Tensor[float]` of `simplexPoints` with fractional coordinates (e.g., from grid or random sampling) to points in a cartesian space (within unit n-sphere)

utils/stitching.nim

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import ../nimplex
1313
## on per-subgraph basis, which should be extremely useful for (a) combining the power of many specialized models and (b)
1414
## creating stacked spaces for multi-step problems broken down into individual steps.
1515
##
16-
## **Navigation:** [nimplex](../nimplex.html) (core library) | [docs/changelog](../docs/changelog.html) | [utils/plotting](plotting.html)
16+
## **Navigation:** [nimplex](../nimplex.html) (core library) | [docs/changelog](../docs/changelog.html) | [utils/plotting](plotting.html) | [utils/stitching](stitching.html)
1717
##
1818

1919

0 commit comments

Comments
 (0)