-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Prepared Home, Dev Guide and About sections (#592)
* docs(gh_pages): Prepared Home, Dev Guide and About sections Signed-off-by: Oleg Kopysov <[email protected]> * fix: add empty lines at the end of files Signed-off-by: Oleg Kopysov <[email protected]> --------- Signed-off-by: Oleg Kopysov <[email protected]>
- Loading branch information
Showing
19 changed files
with
565 additions
and
263 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,3 +28,6 @@ target/ | |
| LPVS/Projects/ | ||
| LPVS/Results/ | ||
| *.iml | ||
|
|
||
| # MkDocs generated website | ||
| doc/site/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # License | ||
|
|
||
| The legal stuff. | ||
|
|
||
| --- | ||
|
|
||
| ## LPVS License (MIT) | ||
|
|
||
| Copyright (c) 2022, Samsung Electronics Co., Ltd. All rights reserved. | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in | ||
| all copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Releases | ||
|
|
||
| Where to get the latest released version of LPVS. | ||
|
|
||
| --- | ||
|
|
||
| ## Used version | ||
|
|
||
| You can determine your currently used version of LPVS by running the next command in console and checking the logs: | ||
|
|
||
| ```console | ||
| $ java -jar lpvs-x.y.z.jar | ||
| ``` | ||
|  | ||
|
|
||
| ## Latest releases | ||
|
|
||
| Actual releases with release notes are available on [GitHub](https://github.com/Samsung/LPVS/releases). | ||
|
|
||
| ## Maintenance team | ||
|
|
||
| The current and past members of the LPVS team. | ||
|
|
||
| * [@MoonkiHong](https://github.com/MoonkiHong/) | ||
| * [@tiokim](https://github.com/tiokim/) | ||
| * [@o-kopysov](https://github.com/o-kopysov/) | ||
| * [@tdrozdovsky](https://github.com/tdrozdovsky/) | ||
| * [@m-rudyk](https://github.com/m-rudyk/) | ||
| * [@v-kerimov](https://github.com/v-kerimov/) | ||
| * [@o-konoval](https://github.com/o-konoval/) | ||
| * [@t-naumenko](https://github.com/t-naumenko/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| div.col-md-9 h1:first-of-type { | ||
| text-align: center; | ||
| font-size: 60px; | ||
| font-weight: 300; | ||
| } | ||
|
|
||
| div.col-md-9>p:first-of-type { | ||
| text-align: center; | ||
| } | ||
|
|
||
| div.col-md-9 p.admonition-title:first-of-type { | ||
| text-align: left; | ||
| } | ||
|
|
||
| div.col-md-9 h1:first-of-type .headerlink { | ||
| display: none; | ||
| } | ||
|
|
||
| div.admonition.block>.admonition-title { | ||
| display: none; | ||
| } | ||
|
|
||
| .admonition.new, details.new { | ||
| color: var(--bs-success-text-emphasis); | ||
| background-color: var(--bs-success-bg-subtle); | ||
| border-color: var(--bs-success-border-subtle); | ||
| } | ||
| .admonition.example, details.example { | ||
| color: var(--bs-info-text-emphasis); | ||
| background-color: var(--bs-info-bg-subtle); | ||
| border-color: var(--bs-info-border-subtle); | ||
| } | ||
|
|
||
| /* Definition List styles */ | ||
|
|
||
| dd { | ||
| padding-left: 20px; | ||
| } | ||
|
|
||
| .card-body svg { | ||
| width: 100%; | ||
| padding: 0 50px; | ||
| height: auto; | ||
| } | ||
|
|
||
| /* Homepage */ | ||
|
|
||
| body.homepage>div.container>div.row>div.col-md-3 { | ||
| display: none; | ||
| } | ||
|
|
||
| body.homepage>div.container>div.row>div.col-md-9 { | ||
| margin-left: 0; | ||
| flex: 0 0 100%; | ||
| max-width: 100%; | ||
| } | ||
|
|
||
| /* mkdocstrings */ | ||
|
|
||
| .doc-object { | ||
| padding-left: 10px; | ||
| border-left: 4px solid var(--bs-light-border-subtle); | ||
| } | ||
|
|
||
| .doc-contents .field-body p:first-of-type { | ||
| display: inline; | ||
| } | ||
|
|
||
| .doc-label-class-attribute, | ||
| .doc-label-instance-attribute { | ||
| display: none; | ||
| } | ||
|
|
||
| h2.doc-heading { | ||
| font-size: 1.5rem; | ||
| } | ||
| h3.doc-heading { | ||
| font-size: 1.4rem; | ||
| } | ||
| h4.doc-heading { | ||
| font-size: 1.3rem; | ||
| } | ||
| h5.doc-heading { | ||
| font-size: 1.2rem; | ||
| } | ||
|
|
||
| .doc-contents { | ||
| padding-left: 0; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Developer Guide | ||
|
|
||
| Extending LPVS | ||
|
|
||
| --- | ||
|
|
||
| The LPVS Developer Guide provides documentation for developers and contributors. | ||
| You can jump directly to the pages listed below, or use the *next* and *previous* buttons | ||
| in the navigation bar at the top of the page to move through the documentation in order. | ||
|
|
||
| - [Contributing guide] | ||
| - [Testing policy] | ||
| - [Code review requirements] | ||
| - [API reference] | ||
| - [Integration guide] | ||
|
|
||
| [Contributing guide]: contributing.md | ||
| [Testing policy]: testing_policy.md | ||
| [Code review requirements]: code-review-requirements.md | ||
| [API reference]: api.md | ||
| [Integration guide]: integration.md |
Oops, something went wrong.