Simplified doc-site generationjellyfish_9.99.4jellyfish/9.99.49.99.4

Updated theme to windmill Using Mkdocs static site generator Deployed on readthedocs

Signed-off-by: growupboron <shankhoghosh123@gmail.com>
Change-Id: If62eaaea1855c91b64f687900f54eba6bc1caee8
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25236
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>

6 files changed, 157 insertions, 0 deletions

diff --git a/theme/docs/a/sample-a1.md b/theme/docs/a/sample-a1.md
new file mode 100644
index 0000000..88f9877
--- /dev/null
+++ b/theme/docs/a/sample-a1.md
@@ -0,0 +1,28 @@
+# Heading A1
+
+## Sub-Heading A1 1
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc fringilla volutpat odio, nec iaculis tortor laoreet vitae. Suspendisse dictum nibh nulla, non fringilla sapien mollis sed. Nunc vehicula facilisis tellus, ut tempor massa bibendum sed. Aenean non justo eu nulla luctus aliquam. Nullam eget arcu a urna ultrices volutpat lobortis ut sapien. Fusce vitae dapibus tellus, nec tincidunt metus. Etiam scelerisque orci ac ligula fermentum rhoncus. Ut at nisi quis tellus imperdiet porta. In semper mollis urna, nec ultricies purus bibendum non.
+
+## Sub-Heading A1 2
+
+First Header | Second Header | Third Header
+-----------  |:-------------:| -----------:
+Left         | Center        | Right
+Left         | Center        | Right
+Left         | Center        | Right
+Left         | Center        | Right
+
+Etiam et sollicitudin dui, at tempor nulla. Suspendisse vitae scelerisque metus. Curabitur efficitur elementum felis id molestie. Proin auctor nulla nec tellus rhoncus, a rhoncus quam volutpat. Integer faucibus nisl et augue tincidunt convallis. Sed aliquet justo vel risus tempus, fringilla ultrices tortor fringilla. Nullam enim metus, commodo eu mi consequat, tincidunt varius nisi. Vestibulum aliquam ipsum ex, vel dignissim nulla sodales vel. In quis iaculis magna, sit amet imperdiet nisl.
+
+## Sub-Heading A1 3
+
+Vestibulum nec ultricies odio. Nam ipsum nunc, molestie vitae vehicula eget, fermentum at nulla. Vestibulum porta quam vitae urna tincidunt vehicula. Vivamus varius enim in bibendum maximus. Nam at dolor eget mauris laoreet commodo id eu est. Vestibulum faucibus placerat egestas. Nullam semper dui eget purus lacinia rhoncus. Vestibulum sollicitudin vitae ipsum eget auctor. Vivamus congue lorem gravida mi facilisis, ac gravida erat vulputate. Proin pharetra et nunc quis viverra. Proin dignissim consectetur metus nec eleifend. Nullam vitae ex vel lorem efficitur gravida.
+
+## Sub-Heading A1 4
+
+Aliquam convallis libero suscipit metus interdum, non volutpat enim rhoncus. Suspendisse et purus a ex sodales varius in sit amet quam. Aenean vel dui a mi feugiat aliquet in et lacus. Fusce sagittis, nibh eget lobortis tincidunt, leo eros tincidunt est, eu viverra libero purus ac velit. Aliquam vulputate venenatis sem eget vulputate. Integer sed sapien dui. Donec lacinia sed nisi et varius. Phasellus dictum nec justo quis faucibus. Nunc sed elit convallis, scelerisque erat non, tristique nulla. Sed nec maximus lorem, vitae efficitur est. Sed vel augue nisi.
+
+## Sub-Heading A1 5
+
+Pellentesque convallis ullamcorper facilisis. Donec quis justo et risus luctus fringilla a ac augue. Nulla imperdiet hendrerit consequat. Fusce ullamcorper ante vel nulla pharetra, vitae fringilla metus tincidunt. Curabitur convallis non odio a tempus. Nulla nec lectus viverra mauris faucibus efficitur quis a lectus. Etiam aliquam neque tellus, eget euismod lorem cursus ac. Pellentesque sagittis, quam in finibus vestibulum, elit nunc aliquet ex, vel ullamcorper ex tortor eget nunc. Quisque vestibulum turpis nec efficitur commodo. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam maximus a lorem et congue. Curabitur orci purus, auctor et porttitor euismod, porttitor in magna. Duis rhoncus sed nunc sed sagittis. In sed mauris nec augue luctus blandit.
diff --git a/theme/docs/a/sample-a2.md b/theme/docs/a/sample-a2.md
new file mode 100644
index 0000000..a341445
--- /dev/null
+++ b/theme/docs/a/sample-a2.md
@@ -0,0 +1,21 @@
+# Heading A2
+
+## Sub-Heading A2 1
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc fringilla volutpat odio, nec iaculis tortor laoreet vitae. Suspendisse dictum nibh nulla, non fringilla sapien mollis sed. Nunc vehicula facilisis tellus, ut tempor massa bibendum sed. Aenean non justo eu nulla luctus aliquam. Nullam eget arcu a urna ultrices volutpat lobortis ut sapien. Fusce vitae dapibus tellus, nec tincidunt metus. Etiam scelerisque orci ac ligula fermentum rhoncus. Ut at nisi quis tellus imperdiet porta. In semper mollis urna, nec ultricies purus bibendum non.
+
+## Sub-Heading A2 2
+
+Etiam et sollicitudin dui, at tempor nulla. Suspendisse vitae scelerisque metus. Curabitur efficitur elementum felis id molestie. Proin auctor nulla nec tellus rhoncus, a rhoncus quam volutpat. Integer faucibus nisl et augue tincidunt convallis. Sed aliquet justo vel risus tempus, fringilla ultrices tortor fringilla. Nullam enim metus, commodo eu mi consequat, tincidunt varius nisi. Vestibulum aliquam ipsum ex, vel dignissim nulla sodales vel. In quis iaculis magna, sit amet imperdiet nisl.
+
+## Sub-Heading A2 3
+
+Vestibulum nec ultricies odio. Nam ipsum nunc, molestie vitae vehicula eget, fermentum at nulla. Vestibulum porta quam vitae urna tincidunt vehicula. Vivamus varius enim in bibendum maximus. Nam at dolor eget mauris laoreet commodo id eu est. Vestibulum faucibus placerat egestas. Nullam semper dui eget purus lacinia rhoncus. Vestibulum sollicitudin vitae ipsum eget auctor. Vivamus congue lorem gravida mi facilisis, ac gravida erat vulputate. Proin pharetra et nunc quis viverra. Proin dignissim consectetur metus nec eleifend. Nullam vitae ex vel lorem efficitur gravida.
+
+## Sub-Heading A2 4
+
+Aliquam convallis libero suscipit metus interdum, non volutpat enim rhoncus. Suspendisse et purus a ex sodales varius in sit amet quam. Aenean vel dui a mi feugiat aliquet in et lacus. Fusce sagittis, nibh eget lobortis tincidunt, leo eros tincidunt est, eu viverra libero purus ac velit. Aliquam vulputate venenatis sem eget vulputate. Integer sed sapien dui. Donec lacinia sed nisi et varius. Phasellus dictum nec justo quis faucibus. Nunc sed elit convallis, scelerisque erat non, tristique nulla. Sed nec maximus lorem, vitae efficitur est. Sed vel augue nisi.
+
+## Sub-Heading A2 5
+
+Pellentesque convallis ullamcorper facilisis. Donec quis justo et risus luctus fringilla a ac augue. Nulla imperdiet hendrerit consequat. Fusce ullamcorper ante vel nulla pharetra, vitae fringilla metus tincidunt. Curabitur convallis non odio a tempus. Nulla nec lectus viverra mauris faucibus efficitur quis a lectus. Etiam aliquam neque tellus, eget euismod lorem cursus ac. Pellentesque sagittis, quam in finibus vestibulum, elit nunc aliquet ex, vel ullamcorper ex tortor eget nunc. Quisque vestibulum turpis nec efficitur commodo. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam maximus a lorem et congue. Curabitur orci purus, auctor et porttitor euismod, porttitor in magna. Duis rhoncus sed nunc sed sagittis. In sed mauris nec augue luctus blandit.
diff --git a/theme/docs/customization.md b/theme/docs/customization.md
new file mode 100644
index 0000000..4523d01
--- /dev/null
+++ b/theme/docs/customization.md
@@ -0,0 +1,21 @@
+# Customization
+
+
+For details about standard mkdocs options, see [MkDocs Configuration](http://www.mkdocs.org/user-guide/configuration/).
+
+In addition, the Windmill theme supports a few additional options, which may be
+listed under the `extra:` key of `mkdocs.yml`.
+
+## Extra configuration options
+
+`extra.logo`: Path to a logo to include in the top bar next to the site name.
+
+`extra.version`: Version number to include right under the site name.
+
+`extra.article_nav_top`: Set to `false` to hide the Previous/Next navigation buttons above article contents.
+
+`extra.article_nav_bottom`: Set to `false` to hide the Previous/Next navigation buttons below article contents.
+
+`extra.history_buttons`: Include back/forward buttons in the top bar. This is
+  useful when the documentation site is included into a bare browser, e.g. into
+  an Electron-based application.
diff --git a/theme/docs/index.md b/theme/docs/index.md
new file mode 100644
index 0000000..be1bb25
--- /dev/null
+++ b/theme/docs/index.md
@@ -0,0 +1,52 @@
+# Windmill theme
+
+## About
+
+Windmill theme focuses on clean usable navigation for large documentation
+projects. It retains the state of the menu of pages and folders across page
+transitions, by keeping navigation to an iframe.
+
+It also implements a versatile search, featuring term highlighting, and both a
+quick dropdown and a full-page option that allows the user to come back to
+search results.
+
+Within pages, it uses the default mkdocs theme, including syntax highlighting.
+
+## Installation
+
+Install the Windmill theme using `pip`:
+
+``` sh
+pip install mkdocs-windmill
+```
+
+To install and get started with `mkdocs`, follow [MkDocs documentation](http://www.mkdocs.org/#installation).
+
+## Usage
+
+To use the Windmill theme installed via `pip`, add this to your `mkdocs.yml`:
+
+``` yaml
+theme: 'windmill'
+```
+
+If you cloned Windmill from GitHub:
+
+``` yaml
+theme:
+  name: null
+  custom_dir: '{INSTALL_DIR}/mkdocs_windmill'
+  # Copy settings from mkdocs_theme.yml, which is ignored by custom_dir themes.
+  static_templates: [404.html]
+  search_index_only: true
+  include_search_page: true
+```
+
+Note that it's important for there to exist a homepage, e.g. a top-level root element in mkdocs 1.0+:
+``` yaml
+nav:
+  - Home: index.md
+```
+
+See [Customization](customization.md) for a few extra configuration options
+supported by the Windmill theme.
diff --git a/theme/docs/sample-a.md b/theme/docs/sample-a.md
new file mode 100644
index 0000000..b7d7d7a
--- /dev/null
+++ b/theme/docs/sample-a.md
@@ -0,0 +1,13 @@
+# Heading A
+
+## Sub-Heading 1
+
+ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc fringilla volutpat odio, nec iaculis tortor laoreet vitae. Suspendisse dictum nibh nulla, non fringilla sapien mollis sed. Nunc vehicula facilisis tellus, ut tempor massa bibendum sed. Aenean non justo eu nulla luctus aliquam. Nullam eget arcu a urna ultrices volutpat lobortis ut sapien. Fusce vitae dapibus tellus, nec tincidunt metus. Etiam scelerisque orci ac ligula fermentum rhoncus. Ut at nisi quis tellus imperdiet porta. In semper mollis urna, nec ultricies purus bibendum non.
+
+## Sub-Heading 2
+
+Etiam et sollicitudin dui, at tempor nulla. Suspendisse vitae scelerisque metus. Curabitur efficitur elementum felis id molestie. Proin auctor nulla nec tellus rhoncus, a rhoncus quam volutpat. Integer faucibus nisl et augue tincidunt convallis. Sed aliquet justo vel risus tempus, fringilla ultrices tortor fringilla. Nullam enim metus, commodo eu mi consequat, tincidunt varius nisi. Vestibulum aliquam ipsum ex, vel dignissim nulla sodales vel. In quis iaculis magna, sit amet imperdiet nisl.
+
+## Sub-Heading 3
+
+Vestibulum nec ultricies odio. Nam ipsum nunc, molestie vitae vehicula eget, fermentum at nulla. Vestibulum porta quam vitae urna tincidunt vehicula. Vivamus varius enim in bibendum maximus. Nam at dolor eget mauris laoreet commodo id eu est. Vestibulum faucibus placerat egestas. Nullam semper dui eget purus lacinia rhoncus. Vestibulum sollicitudin vitae ipsum eget auctor. Vivamus congue lorem gravida mi facilisis, ac gravida erat vulputate. Proin pharetra et nunc quis viverra. Proin dignissim consectetur metus nec eleifend. Nullam vitae ex vel lorem efficitur gravida. 
diff --git a/theme/docs/sample-b.md b/theme/docs/sample-b.md
new file mode 100644
index 0000000..511345d
--- /dev/null
+++ b/theme/docs/sample-b.md
@@ -0,0 +1,22 @@
+# Heading B
+
+## Sub-Heading B 1
+
+ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc fringilla volutpat odio, nec iaculis tortor laoreet vitae. Suspendisse dictum nibh nulla, non fringilla sapien mollis sed. Nunc vehicula facilisis tellus, ut tempor massa bibendum sed. Aenean non justo eu nulla luctus aliquam. Nullam eget arcu a urna ultrices volutpat lobortis ut sapien. Fusce vitae dapibus tellus, nec tincidunt metus. Etiam scelerisque orci ac ligula fermentum rhoncus. Ut at nisi quis tellus imperdiet porta. In semper mollis urna, nec ultricies purus bibendum non. 
+
+## Sub-Heading B 2
+
+* Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+* Aenean accumsan nulla iaculis enim fringilla consectetur.
+* Fusce cursus risus ultrices ante placerat ullamcorper.
+* Suspendisse eget ligula non mi suscipit eleifend eget ut neque.
+* Duis nec dolor pharetra, pulvinar ante vel, tristique augue.
+* Nulla semper ante gravida ex tempor commodo vel vitae elit.
+* Nunc ultrices turpis et arcu placerat semper.
+* Integer pellentesque sem luctus metus mattis imperdiet.
+* Sed eget velit non nulla volutpat fermentum et sed nunc.
+* Aenean at diam non magna dignissim iaculis.
+
+## Sub-Heading B 3
+
+Pellentesque hendrerit, enim at dictum dignissim, enim ipsum venenatis velit, sit amet pretium ligula nisi quis libero. Phasellus quis sapien vitae sem lacinia imperdiet. Sed venenatis facilisis orci. Sed blandit, metus et faucibus imperdiet, libero mauris ultrices mauris, quis placerat orci dolor suscipit sem. Praesent pharetra congue ex, quis efficitur felis faucibus id. Nam feugiat erat vel dolor pretium venenatis. Nunc eu quam elit. Nunc at gravida eros. Nullam vitae felis in sem efficitur dictum id at nunc. Suspendisse sagittis diam a justo cursus imperdiet. Nullam dapibus dui id felis malesuada varius. Aenean aliquet, mi ut semper egestas, massa neque posuere urna, non congue neque velit a ante. Pellentesque purus orci, finibus sit amet nisi ullamcorper, hendrerit luctus magna. Vivamus iaculis interdum elit, vitae vulputate diam hendrerit dignissim.