feat(doc): Link to the github source

gluon-lang · Apr 7, 2019 · da75875 · da75875
1 parent e4c8a4f
commit da75875
Show file tree

Hide file tree

Showing 5 changed files with 252 additions and 87 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/doc/Cargo.toml b/doc/Cargo.toml
@@ -32,6 +32,7 @@ serde_derive = "1.0.0"
 serde_json = "1.0.0"
 
 gluon = { version = "0.11.2", path = ".." } # GLUON
+completion = { package = "gluon_completion", version = "0.11.2", path = "../completion" } # GLUON
 
 
 [dev-dependencies]

diff --git a/doc/src/doc/module.html b/doc/src/doc/module.html
@@ -27,7 +27,14 @@
         </nav>
 
         <main class="col-md-9 ml-sm-auto cl-lg-10 pt-3 px-4" role="main">
-            <h1 class="pb-3 mb-4 border-bottom">{{name}}</h1>
+            <div class="row pb-3 mb-4 border-bottom">
+                <h1 class="col-md-10">{{name}}</h1>
+                {{#if @root.github_source}}
+                <div class="col-md-2">
+                    <a class="float-right" href="{{@root.github_source}}/tree/master/{{symbol_to_path name}}.glu">[src]</a>
+                </div>
+                {{/if}}
+            </div>
 
             {{#if sub_modules}}
             <h2>Modules</h2>
@@ -53,10 +60,22 @@ <h2>Modules</h2>
             <h2 class="pb-3 mb-4 border-bottom"><a class="anchor field" id="Types" href="#Types">Types</a></h2>
             {{#each record.types}}
 
-                <h4>
-                    <pre>type <a id="type.{{name}}" href="#type.{{name}}">{{name}}</a>{{#each args}} {{name}}{{/each}} = {{{type~}}}
-                    </pre>
-                </h4>
+                <div class="row">
+                    <div class="col-md-10">
+                        <h4>
+                            <pre>type <a id="type.{{name}}" href="#type.{{name}}">{{name}}</a>{{#each args}} {{name}}{{/each}} = {{{type~}}}
+                            </pre>
+                        </h4>
+                    </div>
+
+                    {{#if @root.github_source}}
+                    {{#if definition_line}}
+                    <div class="col-md-2">
+                        <a class="float-right" href="{{@root.github_source}}/tree/master/{{symbol_to_path @root.name}}.glu#L{{definition_line}}">[src]</a>
+                    </div>
+                    {{/if}}
+                    {{/if}}
+                </div>
                 <div class="docblock">{{markdown comment}}</div>
 
             {{/each}}
@@ -66,13 +85,25 @@ <h4>
             <h2 class="pb-3 mb-4 border-bottom"><a class="anchor field" id="Values" href="#Values">Values</a></h2>
             {{#each record.values}}
 
-                <h4>
-                <pre>let <a class="anchor field" id="value.{{name}}" href="#value.{{name}}">{{name}}</a>
-                    {{~#each args~}}
-                        {{~#if implicit}} ?{{name}}{{else}} {{name}}{{~/if~}}
-                    {{~/each}} : {{{type~}}}
-                </pre>
-                </h4>
+                <div class="row">
+                    <div class="col-md-10">
+                        <h4>
+                        <pre>let <a class="anchor field" id="value.{{name}}" href="#value.{{name}}">{{name}}</a>
+                            {{~#each args~}}
+                                {{~#if implicit}} ?{{name}}{{else}} {{name}}{{~/if~}}
+                            {{~/each}} : {{{type~}}}
+                        </pre>
+                        </h4>
+                    </div>
+
+                    {{#if @root.github_source}}
+                    {{#if definition_line}}
+                    <div class="col-md-2">
+                        <a class="float-right" href="{{@root.github_source}}/tree/master/{{symbol_to_path @root.name}}.glu#L{{definition_line}}">[src]</a>
+                    </div>
+                    {{/if}}
+                    {{/if}}
+                </div>
                 <div class="docblock">{{markdown comment}}</div>
 
             {{/each}}