Merge pull request #1 from Salaah01/docs

Docs
Salaah01 · Jun 24, 2023 · 716a4c4 · 716a4c4
2 parents 86a1b59 + ca1bf28
commit 716a4c4
Show file tree

Hide file tree

Showing 81 changed files with 3,218 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -207,4 +207,6 @@ Cargo.lock
 .history
 .ionide
 
-# End of https://www.toptal.com/developers/gitignore/api/rust,python,visualstudiocode
+# End of https://www.toptal.com/developers/gitignore/api/rust,python,visualstudiocode
+
+tmp.*
diff --git a/Makefile b/Makefile
@@ -17,3 +17,9 @@ compile-linux:
 copy-linux-executable:
 	cp $(COMPILED_LINUX_PATH) $(ADAPTERS_PYTHON_BIN_PATH)/jsonl_converter
 
+build-docs:
+	rm -rf docs/cargo
+	cd jsonl_converter \
+	&& cargo doc --no-deps \
+	&& mkdir -p ../docs/cargo \
+	&& cp -r target/doc/* ../docs/cargo
diff --git a/README.md b/README.md
@@ -1 +1,11 @@
-# json-lineage
+# JSON Linage (In Development)
+
+**Full documentation can be found at the [GitHub Pages](https://salaah01.github.io/json-lineage/) for this project.**
+
+## Introduction
+
+JSON Linage is a tool that allows you to coverage JSON to JSONL (JSON Lines) format as well as iteratively parse JSON where the JSON contains a list of objects.
+
+The underlying program is written in Rust and is built to feed one JSON object at a time to the parser. This allows for the parsing of very large JSON files that would otherwise not fit into memory.
+
+Additionally, this project contains adapters for easy integration into other programming languages. Currently, there is only a Python adapter, but more are planned.
diff --git a/docs/cargo/crates.js b/docs/cargo/crates.js
@@ -0,0 +1 @@
+window.ALL_CRATES = ["jsonl_converter"];
diff --git a/docs/cargo/help.html b/docs/cargo/help.html
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Documentation for Rustdoc"><title>Rustdoc help</title><link rel="preload" as="font" type="font/woff2" crossorigin href="./static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="./static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="./static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="./static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="./static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="./static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="./static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="./static.files/rustdoc-ba5701c5741a7b69.css" id="mainThemeStyle"><div id="rustdoc-vars" data-root-path="./" data-static-root-path="./static.files/" data-current-crate="jsonl_converter" data-themes="" data-resource-suffix="" data-rustdoc-version="1.70.0 (90c541806 2023-05-31)" data-search-js="search-e077946657036a58.js" data-settings-js="settings-298e1ea74db45b39.js" data-settings-css="settings-7bfb4c59cc6bc502.css" data-theme-light-css="light-0f8c037637f9eb3e.css" data-theme-dark-css="dark-1097f8e92a01e3cf.css" data-theme-ayu-css="ayu-614652228113ac93.css" ></div><script src="./static.files/storage-62ce34ea385b278a.js"></script><script defer src="./static.files/main-f61008743c98d196.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="./static.files/light-0f8c037637f9eb3e.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="./static.files/dark-1097f8e92a01e3cf.css"><link rel="stylesheet" href="./static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="./static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="./static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="./static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="logo-container" href="./jsonl_converter/index.html"><img class="rust-logo" src="./static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="./jsonl_converter/index.html"><img class="rust-logo" src="./static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location">Help</h2><div class="sidebar-elems"></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="./help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="./settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="./static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Rustdoc help</h1><span class="out-of-band"><a id="back" href="javascript:void(0)" onclick="history.back();">Back</a></span></div><noscript><section><p>You need to enable Javascript to use keyboard commands or search.</p><p>For more information, browse the <a href="https://doc.rust-lang.org/rustdoc/">rustdoc handbook</a>.</p></section></noscript></section></div></main></body></html>
diff --git a/docs/cargo/implementors/core/fmt/trait.Display.js b/docs/cargo/implementors/core/fmt/trait.Display.js
diff --git a/docs/cargo/implementors/core/iter/traits/exact_size/trait.ExactSizeIterator.js b/docs/cargo/implementors/core/iter/traits/exact_size/trait.ExactSizeIterator.js
diff --git a/docs/cargo/implementors/core/iter/traits/iterator/trait.Iterator.js b/docs/cargo/implementors/core/iter/traits/iterator/trait.Iterator.js
diff --git a/docs/cargo/implementors/core/marker/trait.Freeze.js b/docs/cargo/implementors/core/marker/trait.Freeze.js
diff --git a/docs/cargo/implementors/core/marker/trait.Send.js b/docs/cargo/implementors/core/marker/trait.Send.js
diff --git a/docs/cargo/implementors/core/marker/trait.Sync.js b/docs/cargo/implementors/core/marker/trait.Sync.js
diff --git a/docs/cargo/implementors/core/marker/trait.Unpin.js b/docs/cargo/implementors/core/marker/trait.Unpin.js
diff --git a/docs/cargo/implementors/core/panic/unwind_safe/trait.RefUnwindSafe.js b/docs/cargo/implementors/core/panic/unwind_safe/trait.RefUnwindSafe.js
diff --git a/docs/cargo/implementors/core/panic/unwind_safe/trait.UnwindSafe.js b/docs/cargo/implementors/core/panic/unwind_safe/trait.UnwindSafe.js