From 7edba2d10f980016462f917c6d21d64585ddfd6b Mon Sep 17 00:00:00 2001
From: Adam Izraelevitz
Date: Fri, 21 Aug 2020 12:02:26 -0700
Subject: Added website docs and mdoc. (#1560)
* Added website docs and mdoc. Removed all warnings
* Updated README and added build to circle ci
* Added how to build documentation, deprecated wiki
* Fix copypasta
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>---
docs/src/images/Makefile | 12 +
docs/src/images/chisel_logo.png | Bin 0 -> 33246 bytes
docs/src/images/chisel_logo.svg | 12593 +++++++++++++++++++++++++++++++++++
docs/src/images/fir_filter.svg | 126 +
docs/src/images/type_hierarchy.dot | 52 +
docs/src/images/type_hierarchy.png | Bin 0 -> 34477 bytes
docs/src/images/type_hierarchy.svg | 261 +
docs/src/images/vec-forall.svg | 330 +
8 files changed, 13374 insertions(+)
create mode 100644 docs/src/images/Makefile
create mode 100644 docs/src/images/chisel_logo.png
create mode 100644 docs/src/images/chisel_logo.svg
create mode 100644 docs/src/images/fir_filter.svg
create mode 100644 docs/src/images/type_hierarchy.dot
create mode 100644 docs/src/images/type_hierarchy.png
create mode 100644 docs/src/images/type_hierarchy.svg
create mode 100644 docs/src/images/vec-forall.svg
(limited to 'docs/src/images')
diff --git a/docs/src/images/Makefile b/docs/src/images/Makefile
new file mode 100644
index 00000000..20a41d1f
--- /dev/null
+++ b/docs/src/images/Makefile
@@ -0,0 +1,12 @@
+.PHONY: all
+
+sources = \
+ type_hierarchy.dot
+
+all: $(sources:%.dot=%.svg) $(sources:%.dot=%.png)
+
+%.svg: %.dot
+ dot -Tsvg $< -o $@
+
+%.png: %.dot
+ dot -Tpng $< -o $@
diff --git a/docs/src/images/chisel_logo.png b/docs/src/images/chisel_logo.png
new file mode 100644
index 00000000..df7d0001
Binary files /dev/null and b/docs/src/images/chisel_logo.png differ
diff --git a/docs/src/images/chisel_logo.svg b/docs/src/images/chisel_logo.svg
new file mode 100644
index 00000000..a6b1e273
--- /dev/null
+++ b/docs/src/images/chisel_logo.svg
@@ -0,0 +1,12593 @@
+
+
+
+
\ No newline at end of file
diff --git a/docs/src/images/fir_filter.svg b/docs/src/images/fir_filter.svg
new file mode 100644
index 00000000..c2627b88
--- /dev/null
+++ b/docs/src/images/fir_filter.svg
@@ -0,0 +1,126 @@
+
+
\ No newline at end of file
diff --git a/docs/src/images/type_hierarchy.dot b/docs/src/images/type_hierarchy.dot
new file mode 100644
index 00000000..d3bf6eb4
--- /dev/null
+++ b/docs/src/images/type_hierarchy.dot
@@ -0,0 +1,52 @@
+digraph TypeHierarchy {
+ graph [rankdir=BT bgcolor="transparent"]
+ { node [style=filled,shape=box]
+ { node [fillcolor="#f7fbff"]
+ Data
+ Element
+ Bits Num
+ Aggregate
+ VecLike
+ "Chisel Internal"
+ }
+ { node [fillcolor="#e5f5e0"]
+ Bool UInt SInt FixedPoint
+ Reset
+ AsyncReset
+ Record
+ Bundle
+ Vec
+ "Chisel Types"
+ }
+ { node [fillcolor="#fcbba1"]
+ "User Types"
+ Ellipsis [label="..."]
+ }
+
+ subgraph cluster_data_hierarchy {
+ color=transparent
+ Element
+ Bits Num
+ Reset
+ Bool UInt SInt FixedPoint
+ color=transparent
+ Aggregate
+ VecLike
+ Record
+ Bundle
+ Vec
+
+ {Aggregate Element} -> Data
+ {Bits Reset} -> Element
+ {FixedPoint SInt UInt} -> {Bits Num}
+ Bool -> {UInt Reset}
+ Ellipsis -> Bundle -> Record -> Aggregate
+ Vec -> {Aggregate VecLike}
+ AsyncReset -> {Element Reset}
+ }
+ subgraph cluster_legend {
+ label=Legend
+ "User Types" -> "Chisel Types" -> "Chisel Internal"
+ }
+ }
+}
diff --git a/docs/src/images/type_hierarchy.png b/docs/src/images/type_hierarchy.png
new file mode 100644
index 00000000..f3947975
Binary files /dev/null and b/docs/src/images/type_hierarchy.png differ
diff --git a/docs/src/images/type_hierarchy.svg b/docs/src/images/type_hierarchy.svg
new file mode 100644
index 00000000..c120daba
--- /dev/null
+++ b/docs/src/images/type_hierarchy.svg
@@ -0,0 +1,261 @@
+
+
+
+
+
diff --git a/docs/src/images/vec-forall.svg b/docs/src/images/vec-forall.svg
new file mode 100644
index 00000000..24c6a267
--- /dev/null
+++ b/docs/src/images/vec-forall.svg
@@ -0,0 +1,330 @@
+
+
+
+
--
cgit v1.2.3