Add Icons and Installation Docs

docs/source/conf.py

@@ -54,8 +54,8 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinx_book_theme"
-# html_logo = ""
-# html_favicon = ""
+html_logo = "_static/images/logos/fire-icon.png"
+html_favicon = "_static/images/logos/fire-icon.png"
 html_static_path = ["_static"]
 html_theme_options = {
     "logo": {

docs/source/index.md

@@ -1,5 +1,55 @@
 # VisualTorch Documentation
 
-VisualTorch aims to help visualize Torch-based neural network architectures. It currently supports generating layered-style and graph-style architectures for PyTorch Sequential and Custom models. This tool is adapted from visualkeras, pytorchviz, and pytorch-summary.
+VisualTorch aims to help visualize Torch-based neural network architectures. It currently supports generating layered-style and graph-style architectures for PyTorch Sequential and Custom models.
 
 🚧 This documentation is under construction 🚧
+
+## {octicon}`rocket` Get Started
+
+::::{grid}
+
+:::{grid-item-card} {octicon}`tools` Installation
+:link: markdown/get_started/installation
+:link-type: doc
+
+Installing visualtorch via PyPI or Source.
+:::
+
+::::
+
+```{toctree}
+:caption: Get Started
+:hidden:
+
+markdown/get_started/installation
+```
+
+```{toctree}
+:caption: Usage Examples
+:hidden:
+
+markdown/usage_examples/layered
+markdown/usage_examples/graph
+```
+
+```{toctree}
+:caption: References
+:hidden:
+
+markdown/references/layered
+markdown/references/graph
+```
+
+```{toctree}
+:caption: Developer Guides
+:hidden:
+
+markdown/developer_guides/contributing
+```
+
+```{toctree}
+:caption: License
+:hidden:
+
+markdown/license/index
+```

docs/source/markdown/get_started/installation.md

@@ -0,0 +1,31 @@
+# {octicon}`tools` Installation
+
+Installation can be done through PyPI or the GitHub repository. PyPI installation should be chosen if you want to use the release version. If you prefer to use the latest version from the GitHub repository, then installation from the source is recommended.
+
+:::::{dropdown} Installation via pip
+:open:
+
+VisualTorch can be installed using the following commands:
+
+::::{tab-set}
+
+:::{tab-item} PyPI
+:sync: label-1
+
+```{literalinclude} ../../snippets/install/pypi.txt
+:language: bash
+```
+
+:::
+
+:::{tab-item} Source
+:sync: label-2
+
+```{literalinclude} ../../snippets/install/source.txt
+:language: bash
+```
+
+:::
+::::
+
+:::::

docs/source/snippets/install/pypi.txt

@@ -0,0 +1 @@
+pip install visualtorch

docs/source/snippets/install/source.txt

@@ -0,0 +1 @@
+pip install git+https://github.com/willyfh/visualtorch