Spaces:
Running
Running
Basic MkDocs setup.
Browse files- README.md +10 -0
- docs/index.md +3 -0
- docs/lynxkite-core.md +6 -0
- docs/lynxkite-graph-analytics.md +6 -0
- mkdocs.yml +11 -0
README.md
CHANGED
|
@@ -14,6 +14,7 @@ original LynxKite. The primary goals of this rewrite are:
|
|
| 14 |
- `lynxkite-graph-analytics`: Graph analytics plugin. The classical LynxKite experience!
|
| 15 |
- `lynxkite-pillow`: A simple example plugin.
|
| 16 |
- `lynxkite-lynxscribe`: A plugin for building and running LynxScribe applications.
|
|
|
|
| 17 |
|
| 18 |
## Development
|
| 19 |
|
|
@@ -38,3 +39,12 @@ If you also want to make changes to the frontend with hot reloading:
|
|
| 38 |
cd lynxkite-app/web
|
| 39 |
npm run dev
|
| 40 |
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 14 |
- `lynxkite-graph-analytics`: Graph analytics plugin. The classical LynxKite experience!
|
| 15 |
- `lynxkite-pillow`: A simple example plugin.
|
| 16 |
- `lynxkite-lynxscribe`: A plugin for building and running LynxScribe applications.
|
| 17 |
+
- `docs`: User-facing documentation. It's shared between all packages.
|
| 18 |
|
| 19 |
## Development
|
| 20 |
|
|
|
|
| 39 |
cd lynxkite-app/web
|
| 40 |
npm run dev
|
| 41 |
```
|
| 42 |
+
|
| 43 |
+
## Documentation
|
| 44 |
+
|
| 45 |
+
To work on the documentation:
|
| 46 |
+
|
| 47 |
+
```bash
|
| 48 |
+
uv pip install mkdocs-material mkdocstrings[python]
|
| 49 |
+
mkdocs serve
|
| 50 |
+
```
|
docs/index.md
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Getting started
|
| 2 |
+
|
| 3 |
+
Good luck getting started!
|
docs/lynxkite-core.md
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# LynxKite Core
|
| 2 |
+
|
| 3 |
+
LynxKite core is for writing LynxKite plugins.
|
| 4 |
+
It contains core types and utilities that can be used by all LynxKite plugins.
|
| 5 |
+
|
| 6 |
+
::: lynxkite.core.ops
|
docs/lynxkite-graph-analytics.md
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# LynxKite Graph Analytics
|
| 2 |
+
|
| 3 |
+
This is the classical LynxKite experience!
|
| 4 |
+
The graph analytics plugin is a collection of graph algorithms that can be run on a LynxKite graph.
|
| 5 |
+
|
| 6 |
+
::: lynxkite_plugins.graph_analytics.lynxkite_ops
|
mkdocs.yml
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
site_name: "LynxKite"
|
| 2 |
+
|
| 3 |
+
theme:
|
| 4 |
+
name: "material"
|
| 5 |
+
|
| 6 |
+
plugins:
|
| 7 |
+
- search
|
| 8 |
+
- mkdocstrings:
|
| 9 |
+
handlers:
|
| 10 |
+
python:
|
| 11 |
+
paths: ["./lynxkite-app/src", "./lynxkite-core/src", "./lynxkite-graph-analytics/src", "./lynxkite-lynxscribe/src"]
|