origen_doc_helpers 0.8.1 → 0.8.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/config/application.rb +1 -1
- data/config/version.rb +1 -1
- data/lib/origen_doc_helpers/guide_index.rb +1 -1
- data/templates/model_index.md.erb +1 -1
- data/templates/model_page.md.erb +1 -1
- data/templates/web/helpers.md.erb +1 -1
- data/templates/web/helpers/model.md.erb +2 -2
- data/templates/web/helpers/register.md.erb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 183ce3d4c6b7a9acfddd0d772a99714914ad1a05415f9914d68a2c8ba34d54f6
|
|
4
|
+
data.tar.gz: bb0e2323376a9eaac095020ead1218b6df0a3c4f464fa7044fa7ac0fdfda385e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 66fe26cf4469a3eb6675f33dfa79e2538b78de11464d68902b825d993f7deeace11a644e61584c1e127076840948b90d4781649338910a4a755e4d9d51f32656
|
|
7
|
+
data.tar.gz: 84b6bcf4eef638401d47b85dfff51825b0e42b677865041119181e1f7bdf4b777af3d0822c97c304c23915f48e31551081dba759b5507e71be144426e25fe9d8
|
data/config/application.rb
CHANGED
|
@@ -8,7 +8,7 @@ class OrigenDocHelpersApplication < Origen::Application
|
|
|
8
8
|
# To enable deployment of your documentation to a web server (via the 'origen web'
|
|
9
9
|
# command) fill in these attributes.
|
|
10
10
|
config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/doc_helpers"
|
|
11
|
-
config.web_domain = "
|
|
11
|
+
config.web_domain = "https://origen-sdk.org/doc_helpers"
|
|
12
12
|
config.disqus_shortname = "origen-sdk"
|
|
13
13
|
|
|
14
14
|
config.semantically_version = true
|
data/config/version.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
module OrigenDocHelpers
|
|
2
2
|
# Provides an API to programatically construct an index hash as used
|
|
3
3
|
# by the Searchable Documents helper -
|
|
4
|
-
#
|
|
4
|
+
# https://origen-sdk.org/doc_helpers/helpers/searchable/intro/#The_Document_Index
|
|
5
5
|
class GuideIndex
|
|
6
6
|
def initialize
|
|
7
7
|
@index = {}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
<div class="row" style="margin-top: 10px; margin-bottom: 15px;">
|
|
5
5
|
<div class="col-md-9">
|
|
6
|
-
<img src="
|
|
6
|
+
<img src="https://origen-sdk.org/img/origen-device.png" style="float: left; height:50px; width: 50px; margin-top: 14px;">
|
|
7
7
|
<h1 style="float: left; margin-left: 10px;">Models</h1>
|
|
8
8
|
</div>
|
|
9
9
|
</div>
|
data/templates/model_page.md.erb
CHANGED
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
|
|
21
21
|
<div class="row" style="margin-top: 10px; margin-bottom: 15px;">
|
|
22
22
|
<div class="col-md-9">
|
|
23
|
-
<img src="
|
|
23
|
+
<img src="https://origen-sdk.org/img/origen-device.png" style="float: left; height:50px; width: 50px; margin-top: 14px;">
|
|
24
24
|
<h1 style="float: left; margin-left: 10px;"><%= opts[:heading] %></h1>
|
|
25
25
|
</div>
|
|
26
26
|
% if opts[:search_box]
|
|
@@ -16,7 +16,7 @@ These helpers will generate complete web pages for you.
|
|
|
16
16
|
|
|
17
17
|
The following are components that you can embed within your own web pages.
|
|
18
18
|
|
|
19
|
-
| [Searchable Documents](<%= path "/helpers/searchable/intro" %>) | Provides a layout for a guides section of your website, complete with search box (the [Origen Guides](
|
|
19
|
+
| [Searchable Documents](<%= path "/helpers/searchable/intro" %>) | Provides a layout for a guides section of your website, complete with search box (the [Origen Guides](https://origen-sdk.org/guides) uses this)
|
|
20
20
|
| [Register Descriptions](<%= path "/helpers/register" %>) | Create a tabular register view, similar to that used in device reference manuals
|
|
21
21
|
| [Yammer Comments](<%= path "/helpers/yammer" %>) | Embed a comments section at the bottom of your page using Yammer
|
|
22
22
|
| [Disqus Comments](<%= path "/helpers/disqus" %>) | Embed a comments section at the bottom of your page using Disqus
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
This helper will build a collection of web pages that document a model's attributes,
|
|
6
6
|
currently this includes its sub-blocks and registers.
|
|
7
7
|
|
|
8
|
-
[Here is an example](
|
|
8
|
+
[Here is an example](https://origen-sdk.org/link_demo/models/linkdemo_toplevel/).
|
|
9
9
|
|
|
10
|
-
Multiple models can be supplied and an [index page like this](
|
|
10
|
+
Multiple models can be supplied and an [index page like this](https://origen-sdk.org/link_demo/models)
|
|
11
11
|
is generated to help locate the documentation for a given model.
|
|
12
12
|
|
|
13
13
|
The collection of pages associated with a particular model is also fully searchable via
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Register Helpers
|
|
4
4
|
|
|
5
|
-
Use the [Origen register API](
|
|
5
|
+
Use the [Origen register API](https://origen-sdk.org/origen/guides/models/registers)
|
|
6
6
|
to define registers in the normal way,
|
|
7
7
|
all of the examples are here are based on this register definition:
|
|
8
8
|
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: origen_doc_helpers
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.8.
|
|
4
|
+
version: 0.8.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Stephen McGinty
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2019-
|
|
11
|
+
date: 2019-08-02 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: origen
|
|
@@ -76,7 +76,7 @@ files:
|
|
|
76
76
|
- templates/web/layouts/_helpers.html.erb
|
|
77
77
|
- templates/web/partials/_navbar.html.erb
|
|
78
78
|
- templates/web/release_notes.md.erb
|
|
79
|
-
homepage:
|
|
79
|
+
homepage: https://origen-sdk.org/doc_helpers
|
|
80
80
|
licenses:
|
|
81
81
|
- MIT
|
|
82
82
|
metadata: {}
|