Skip to content
This repository was archived by the owner on Nov 23, 2023. It is now read-only.

Try generating ExDoc documentation #28

Open
erszcz wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Try generating ExDoc documentation #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
27a9563
Try generating ExDoc documentation
erszcz Oct 30, 2019
6321b44
Add docsh_exdoc.hrl to more files
erszcz Nov 2, 2019
f8327e9
Disable rebar3_docsh - ExDoc can't handle it
erszcz Nov 2, 2019
b5982eb
Save snippets
erszcz Nov 2, 2019
284868b
Add docs/ built with ExDoc @ c5c8542 supporting Erlang
erszcz Nov 2, 2019
43d9d9e
Remove .html from .gitignore
erszcz Nov 2, 2019
1ce3664
Write down TODOs
erszcz Nov 2, 2019
5518241
Remove docsh_exdoc.hrl
erszcz Nov 2, 2019
96b6dd0
Update docs/
erszcz Nov 2, 2019
7dec154
Save snippets
erszcz Nov 2, 2019
02a4a72
Update TODOs
erszcz Nov 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,4 @@ tags
*.E
*.ast
*.log
*.html
*.xml
28 changes: 28 additions & 0 deletions docs/.build
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
dist/search_items-8fe9516a4a.js
dist/app-a9f3287e74588dddabf3.js
dist/elixir-6164d407479bd2888d0e.css
dist/erlang-94f16191f0a724ab8055.css
dist/html/fonts/icomoon.eot
dist/html/fonts/icomoon.svg
dist/html/fonts/icomoon.ttf
dist/html/fonts/icomoon.woff
dist/sidebar_items-8c8e7576ef.js
api-reference.html
search.html
404.html
docsh.html
docsh_beam.html
docsh_docs_v1.html
docsh_edoc.html
docsh_edoc_xmerl.html
docsh_edoc_xmerl_flat.html
docsh_erl.html
docsh_format.html
docsh_internal.html
docsh_lib.html
docsh_reader.html
docsh_syntax.html
docsh_tracer.html
docsh_user_default.html
docsh_writer.html
index.html
105 changes: 105 additions & 0 deletions docs/404.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.21.2">
<meta name="project" content="docsh v0.7.1">
<title>404 — docsh v0.7.1</title>
<link rel="stylesheet" href="dist/erlang-94f16191f0a724ab8055.css" />
<script src="dist/sidebar_items-8c8e7576ef.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/app-a9f3287e74588dddabf3.js"></script>
</head>
<body data-type="extras">
<script>try { if(localStorage.getItem('night-mode') === 'true') document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">

<button class="sidebar-button sidebar-toggle">
<span class="icon-menu" title="Collapse/expand sidebar"></span>
</button>

<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<button type="button" tabindex="-1" class="search-close-button">
<span class="icon-cross" title="Cancel search"></span>
</button>
<label class="search-label">
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search..." aria-label="Search" autocomplete="off" />
</label>
</form>

<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>

<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="docsh.html" class="sidebar-projectName">
docsh </a>
<h2 class="sidebar-projectVersion">
v0.7.1
</h2>
</div>
</div>

<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>

<li><a id="modules-list" href="#full-list">Modules</a></li>


</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>

<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">

<h2>Page not found</h2>

<p>Sorry, but the page you were trying to get to, does not exist. You
may want to try searching this site using the sidebar
or using our <a href="api-reference.html">API Reference</a> page
to find what you were looking for.</p>

<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener">ExDoc</a> (v0.21.2),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
<p>
<button class="line footer-button display-shortcuts-help">
Display keyboard shortcuts
</button>
<button class="line footer-button night-mode-toggle">
Toggle night mode
</button>
<button class="line footer-button display-quick-switch">
Go to a HexDocs package
</button>
<button class="line footer-button tooltips-toggle">
<span class="tooltips-option-disable">Disable tooltips</span>
<span class="tooltips-option-enable">Enable tooltips</span>
</button>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>
192 changes: 192 additions & 0 deletions docs/api-reference.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.21.2">
<meta name="project" content="docsh v0.7.1">
<title>API Reference — docsh v0.7.1</title>
<link rel="stylesheet" href="dist/erlang-94f16191f0a724ab8055.css" />
<script src="dist/sidebar_items-8c8e7576ef.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/app-a9f3287e74588dddabf3.js"></script>
</head>
<body data-type="extras">
<script>try { if(localStorage.getItem('night-mode') === 'true') document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">

<button class="sidebar-button sidebar-toggle">
<span class="icon-menu" title="Collapse/expand sidebar"></span>
</button>

<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<button type="button" tabindex="-1" class="search-close-button">
<span class="icon-cross" title="Cancel search"></span>
</button>
<label class="search-label">
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search..." aria-label="Search" autocomplete="off" />
</label>
</form>

<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>

<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="docsh.html" class="sidebar-projectName">
docsh </a>
<h2 class="sidebar-projectVersion">
v0.7.1
</h2>
</div>
</div>

<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>

<li><a id="modules-list" href="#full-list">Modules</a></li>


</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>

<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">

<h1>
<small class="app-vsn">docsh v0.7.1</small>
API Reference
</h1>

<section class="details-list">
<h2 id="modules" class="section-heading">
<a href="#modules" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Modules
</h2>

<div class="summary">
<div class="summary-row">
<div class="summary-signature">
<a href="docsh.html">docsh</a>
</div>
<div class="summary-synopsis"><p> Welcome to docsh, a documentation engine for the Erlang shell. This project provides a number of helpers for accessing module and function doc comments, function specs and exported types.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_beam.html">docsh_beam</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_docs_v1.html">docsh_docs_v1</a>
</div>
<div class="summary-synopsis"><p>EEP-0048 (<a href="http://erlang.org/eeps/eep-0048.html">http://erlang.org/eeps/eep-0048.html</a>) docs_v1 documentation format support.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_edoc.html">docsh_edoc</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_edoc_xmerl.html">docsh_edoc_xmerl</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_edoc_xmerl_flat.html">docsh_edoc_xmerl_flat</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_erl.html">docsh_erl</a>
</div>
<div class="summary-synopsis"><p>Documentation lookup functions exported in the Erlang shell.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_format.html">docsh_format</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_internal.html">docsh_internal</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_lib.html">docsh_lib</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_reader.html">docsh_reader</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_syntax.html">docsh_syntax</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_tracer.html">docsh_tracer</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_user_default.html">docsh_user_default</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="docsh_writer.html">docsh_writer</a>
</div>
</div>
</div>
</section>


<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener">ExDoc</a> (v0.21.2),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
<p>
<button class="line footer-button display-shortcuts-help">
Display keyboard shortcuts
</button>
<button class="line footer-button night-mode-toggle">
Toggle night mode
</button>
<button class="line footer-button display-quick-switch">
Go to a HexDocs package
</button>
<button class="line footer-button tooltips-toggle">
<span class="tooltips-option-disable">Disable tooltips</span>
<span class="tooltips-option-enable">Enable tooltips</span>
</button>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>
89 changes: 89 additions & 0 deletions docs/dist/app-a9f3287e74588dddabf3.js
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/dist/elixir-6164d407479bd2888d0e.css
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/dist/erlang-94f16191f0a724ab8055.css
View file
Open in desktop

Large diffs are not rendered by default.

Binary file added docs/dist/html/fonts/icomoon.eot
View file
Open in desktop
Binary file not shown.
19 changes: 19 additions & 0 deletions docs/dist/html/fonts/icomoon.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/dist/html/fonts/icomoon.ttf
View file
Open in desktop
Binary file not shown.
Binary file added docs/dist/html/fonts/icomoon.woff
View file
Open in desktop
Binary file not shown.
Loading