20 | 21 | exrm v0.15.3 22 | 23 |
24 | 25 |26 | 27 | Overview 28 |
29 | 30 | 35 | 36 | 37 | 38 |-
39 |
40 |
4 |
5 | Read the Docs
6 | v: {{ current_version }}
7 |
8 |
9 |
36 | {% endif %}
37 |
38 |
--------------------------------------------------------------------------------
/docs/source/_themes/sphinx_rtd_theme/sphinx_rtd_theme/footer.html:
--------------------------------------------------------------------------------
1 |
33 |
--------------------------------------------------------------------------------
/docs/source/_themes/sphinx_rtd_theme/setup.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | """`sphinx_rtd_theme` lives on `Github`_.
3 |
4 | .. _github: https://www.github.com/snide/sphinx_rtd_theme
5 |
6 | """
7 | from setuptools import setup
8 | from sphinx_rtd_theme import __version__
9 |
10 |
11 | setup(
12 | name='sphinx_rtd_theme',
13 | version=__version__,
14 | url='https://github.com/snide/sphinx_rtd_theme/',
15 | license='MIT',
16 | author='Dave Snider',
17 | author_email='dave.snider@gmail.com',
18 | description='ReadTheDocs.org theme for Sphinx, 2013 version.',
19 | long_description=open('README.rst').read(),
20 | zip_safe=False,
21 | packages=['sphinx_rtd_theme'],
22 | package_data={'sphinx_rtd_theme': [
23 | 'theme.conf',
24 | '*.html',
25 | 'static/css/*.css',
26 | 'static/js/*.js',
27 | 'static/font/*.*'
28 | ]},
29 | include_package_data=True,
30 | install_requires=open('requirements.txt').read().splitlines(),
31 | classifiers=[
32 | 'Development Status :: 3 - Alpha',
33 | 'License :: OSI Approved :: BSD License',
34 | 'Environment :: Console',
35 | 'Environment :: Web Environment',
36 | 'Intended Audience :: Developers',
37 | 'Programming Language :: Python :: 2.7',
38 | 'Programming Language :: Python :: 3',
39 | 'Operating System :: OS Independent',
40 | 'Topic :: Documentation',
41 | 'Topic :: Software Development :: Documentation',
42 | ],
43 | )
44 |
--------------------------------------------------------------------------------
/docs/source/_themes/sphinx_rtd_theme/sass/_theme_badge_fa.sass:
--------------------------------------------------------------------------------
1 | // Slimmer version of FA for use on the badge_only.sass file.
2 |
3 | +font-face(FontAwesome, '#{$font-awesome-dir}fontawesome_webfont')
4 |
5 | .fa:before
6 | display: inline-block
7 | font-family: FontAwesome
8 | font-style: normal
9 | font-weight: normal
10 | line-height: 1
11 | text-decoration: inherit
12 | +font-smooth
13 |
14 | a .fa
15 | display: inline-block
16 | text-decoration: inherit
17 |
18 |
19 | li
20 | .fa
21 | display: inline-block
22 | .fa-large:before,
23 | .fa-large:before
24 | /* 1.5 increased font size for fa-large * 1.25 width
25 | width: 1.5 * 1.25em
26 |
27 | ul.fas
28 | list-style-type: none
29 | margin-left: 2em
30 | text-indent: -0.8em
31 | li
32 | .fa
33 | width: .8em
34 | .fa-large:before,
35 | .fa-large:before
36 | /* 1.5 increased font size for fa-large * 1.25 width
37 | vertical-align: baseline
38 | // width: 1.5*1.25em
39 |
40 | .fa-book:before
41 | content: "\f02d"
42 |
43 | .icon-book:before
44 | content: "\f02d"
45 |
46 | .fa-caret-down:before
47 | content: "\f0d7"
48 |
49 | .icon-caret-down:before
50 | content: "\f0d7"
51 |
52 | .fa-caret-up:before
53 | content: "\f0d8"
54 |
55 | .icon-caret-up:before
56 | content: "\f0d8"
57 |
58 | .fa-caret-left:before
59 | content: "\f0d9"
60 |
61 | .icon-caret-left:before
62 | content: "\f0d9"
63 |
64 | .fa-caret-right:before
65 | content: "\f0da"
66 |
67 | .icon-caret-right:before
68 | content: "\f0da"
69 |
--------------------------------------------------------------------------------
/doc/protocols_list.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
10 |
32 | Free document hosting provided by Read the Docs. 33 | 34 |
35 | -
11 |
- Versions 12 | {% for slug, url in versions %} 13 |
- {{ slug }} 14 | {% endfor %} 15 |
-
17 |
- Downloads 18 | {% for type, url in downloads %} 19 |
- {{ type }} 20 | {% endfor %} 21 |
-
23 |
- On Read the Docs 24 |
- 25 | Project Home 26 | 27 |
- 28 | Builds 29 | 30 |
32 | Free document hosting provided by Read the Docs. 33 | 34 |
20 | 21 | exrm v0.15.3 22 | 23 |
24 | 25 |26 | 27 | Overview 28 |
29 | 30 | 35 | 36 | 37 | 38 |-
39 |
40 |
{{ _('Search Results') }}
34 | {% if not search_results %} 35 |{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}
36 | {% endif %} 37 | {% endif %} 38 |
39 | {% if search_results %}
40 |
50 | {% endblock %}
51 |
--------------------------------------------------------------------------------
/docs/source/_themes/sphinx_rtd_theme/sphinx_rtd_theme/static/js/theme.js:
--------------------------------------------------------------------------------
1 | $( document ).ready(function() {
2 | // Shift nav in mobile when clicking the menu.
3 | $(document).on('click', "[data-toggle='wy-nav-top']", function() {
4 | $("[data-toggle='wy-nav-shift']").toggleClass("shift");
5 | $("[data-toggle='rst-versions']").toggleClass("shift");
6 | });
7 | // Close menu when you click a link.
8 | $(document).on('click', ".wy-menu-vertical .current ul li a", function() {
9 | $("[data-toggle='wy-nav-shift']").removeClass("shift");
10 | $("[data-toggle='rst-versions']").toggleClass("shift");
11 | });
12 | $(document).on('click', "[data-toggle='rst-current-version']", function() {
13 | $("[data-toggle='rst-versions']").toggleClass("shift-up");
14 | });
15 | // Make tables responsive
16 | $("table.docutils:not(.field-list)").wrap("");
17 | });
18 |
19 | window.SphinxRtdTheme = (function (jquery) {
20 | var stickyNav = (function () {
21 | var navBar,
22 | win,
23 | stickyNavCssClass = 'stickynav',
24 | applyStickNav = function () {
25 | if (navBar.height() <= win.height()) {
26 | navBar.addClass(stickyNavCssClass);
27 | } else {
28 | navBar.removeClass(stickyNavCssClass);
29 | }
30 | },
31 | enable = function () {
32 | applyStickNav();
33 | win.on('resize', applyStickNav);
34 | },
35 | init = function () {
36 | navBar = jquery('nav.wy-nav-side:first');
37 | win = jquery(window);
38 | };
39 | jquery(init);
40 | return {
41 | enable : enable
42 | };
43 | }());
44 | return {
45 | StickyNav : stickyNav
46 | };
47 | }($));
48 |
--------------------------------------------------------------------------------
/test/fixtures/example_app/priv/sample.txt:
--------------------------------------------------------------------------------
1 | The Chiss were governed by an oligarchy of extended Ruling Families from House Palace, located in the city of Csaplar. Each clan with the families was headed by leaders known as Aristocra who wore particular colors to indicate their clan and family loyalties. Standard and day-to-day decisions were made by a democratically elected parliamentary body from each of the 28 colonies. Issues were siphoned up through the parliament to a cabinet of appointed governors, and then to the ruling families, where a decision made by the parliament and/or cabinet could be approved for action. Each of the extended ruling families was responsible for a set of government affairs to manage: House Sabosen was responsible for social issues such as justice, health, and education; House Inrokini was responsible for industry and science; House Csapla was responsible for colonial affairs, agriculture and redistribution of resources; and House Nuruodo was responsible for military and foreign affairs. The Csapla's redistribution of resources amongst the Chiss colonies and Csilla was particularly important, given the collectivist-socialist economic system of the Chiss, and led to their relative position at the head of the families, with the others acting in an advisory role. House Nuruodo would be ranked as second, considering the importance of warfare on Chiss society.
2 |
3 | Each family was equally represented in the Chiss government, although they went to great lengths to ensure that family identity was eliminated wherever possible. The leaders of the Chiss did not use names, but instead wore colorful robes to distinguish themselves. This helped ensure that decisions were reached in a fair and equitable method. Although the four extended ruling families were not known to face power struggles, five lesser clans often vied for greater authority and power, such as House Chaf, which was considered the fifth ruling family.
4 |
5 | The vast financial holdings of the Chiss kept their supply lines running and also provided them access to a number of independent shipyards which they used to keep their vessels on constant patrol. It was through such methods that the Chiss maintained a poacher base at the Etyyy hunting grounds on Kashyyyk.
6 |
--------------------------------------------------------------------------------
/doc/css/elixir.css:
--------------------------------------------------------------------------------
1 | .hljs {
2 | overflow-x: auto;
3 | color: #333;
4 | padding: 0.5em;
5 | border: #ffe0bb dotted 1px;
6 | background: #fffde8;
7 | display: block;
8 | -webkit-text-size-adjust: none;
9 | }
10 |
11 | .hljs-comment,
12 | .diff .hljs-header,
13 | .hljs-javadoc {
14 | color: #998;
15 | font-style: italic;
16 | }
17 |
18 | .hljs-keyword,
19 | .css .rule .hljs-keyword,
20 | .hljs-winutils,
21 | .nginx .hljs-title,
22 | .hljs-subst,
23 | .hljs-request,
24 | .hljs-status {
25 | color: #333;
26 | font-weight: bold;
27 | }
28 |
29 | .hljs-number,
30 | .hljs-hexcolor,
31 | .ruby .hljs-constant {
32 | color: #008080;
33 | }
34 |
35 | .hljs-string,
36 | .hljs-tag .hljs-value,
37 | .hljs-phpdoc,
38 | .hljs-dartdoc,
39 | .tex .hljs-formula {
40 | color: #d14;
41 | }
42 |
43 | .hljs-title,
44 | .hljs-id,
45 | .scss .hljs-preprocessor {
46 | color: #900;
47 | font-weight: bold;
48 | }
49 |
50 | .hljs-list .hljs-keyword,
51 | .hljs-subst {
52 | font-weight: normal;
53 | }
54 |
55 | .hljs-class .hljs-title,
56 | .hljs-type,
57 | .vhdl .hljs-literal,
58 | .tex .hljs-command {
59 | color: #445588;
60 | font-weight: bold;
61 | }
62 |
63 | .hljs-tag,
64 | .hljs-tag .hljs-title,
65 | .hljs-rules .hljs-property,
66 | .django .hljs-tag .hljs-keyword {
67 | color: #000080;
68 | font-weight: normal;
69 | }
70 |
71 | .hljs-attribute,
72 | .hljs-variable,
73 | .lisp .hljs-body {
74 | color: #008080;
75 | }
76 |
77 | .hljs-regexp {
78 | color: #009926;
79 | }
80 |
81 | .hljs-symbol,
82 | .ruby .hljs-symbol .hljs-string,
83 | .lisp .hljs-keyword,
84 | .clojure .hljs-keyword,
85 | .scheme .hljs-keyword,
86 | .tex .hljs-special,
87 | .hljs-prompt {
88 | color: #990073;
89 | }
90 |
91 | .hljs-built_in {
92 | color: #0086b3;
93 | }
94 |
95 | .hljs-preprocessor,
96 | .hljs-pragma,
97 | .hljs-pi,
98 | .hljs-doctype,
99 | .hljs-shebang,
100 | .hljs-cdata {
101 | color: #999;
102 | font-weight: bold;
103 | }
104 |
105 | .hljs-deletion {
106 | background: #fdd;
107 | }
108 |
109 | .hljs-addition {
110 | background: #dfd;
111 | }
112 |
113 | .diff .hljs-change {
114 | background: #0086b3;
115 | }
116 |
117 | .hljs-chunk {
118 | color: #aaa;
119 | }
120 |
--------------------------------------------------------------------------------
/doc/ReleaseManager.Config.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | -
41 | {% for href, caption, context in search_results %}
42 |
-
43 | {{ caption }}
44 |
{{ context|e }}
45 |
46 | {% endfor %}
47 |
30 | ReleaseManager.Config 31 | 32 |
33 | 34 |-
35 |
36 |
37 |
38 |
39 |
40 |
Configuration for the release task.
45 |Contains the following values:
46 |name: The name of your application
47 | version: The version of your application
48 | dev?: Is this release being built in dev mode
49 | env: The mix environment the app should be build for
50 | erl: The binary containing all options to pass to erl
51 | upgrade?: Is this release an upgrade?
52 | verbosity: The verbosity level, one of [silent|quiet|normal|verbose]30 | Mix.Tasks.Release.Plugins 31 | 32 |
33 | 34 | 45 | 46 | 47 |View information about active release plugins
49 |Examples
50 |# View all active plugins
51 | mix release.plugins
52 |
53 | # View detailed info about a plugin, if available
54 | mix release.plugins <plugin_name>Summary↑
63 || run(args) | 66 | 67 |Callback implementation of |
69 |
70 |
Functions
80 |Callback implementation of Mix.Task.run/1.
exrm v0.15.3
26 | 27 |-
28 |
29 |
- Modules 30 | 31 | 32 | 33 |
Modules summary ↑
37 || Mix.Tasks.Release | 40 | 41 |Build a release for the current mix application 42 | |
43 |
44 |
| Mix.Tasks.Release.Clean | 47 | 48 |Clean up any release-related files 49 | |
50 |
51 |
| Mix.Tasks.Release.Plugins | 54 | 55 |View information about active release plugins 56 | |
57 |
58 |
| ReleaseManager.Appups | 61 | 62 |Module for auto-generating appups between releases 63 | |
64 |
65 |
| ReleaseManager.Config | 68 | 69 |Configuration for the release task 70 | |
71 |
72 |
| ReleaseManager.Plugin | 75 | 76 |This module provide a simple way to add additional steps to 77 | the release task 78 | |
79 |
80 |
| ReleaseManager.Plugin.Conform | 83 | 84 |Generates a .conf for your release 85 | |
86 |
87 |
| ReleaseManager.Plugin.Consolidation | 90 | 91 ||
| ReleaseManager.Utils | 94 | 95 |This module provides helper functions for the |
98 |
99 |
30 | ReleaseManager.Appups 31 | 32 |
33 | 34 | 45 | 46 | 47 |Module for auto-generating appups between releases.
49 | 50 |Summary↑
57 || make(application, v1, v2, v1_path, v2_path) | 60 | 61 |Generate a .appup for the given application, start version, and upgrade version 62 | |
63 |
64 |
Functions
74 |Generate a .appup for the given application, start version, and upgrade version.
86 |## Parameter information
87 | application: the application name as an atom
88 | v1: the start version, such as "0.0.1"
89 | v2: the upgrade version, such as "0.0.2"
90 | v1_path: the path to the v1 artifacts (rel/<app>/lib/<app>-0.0.1)
91 | v2_path: the path to the v2 artifacts (_build/prod/lib/<app>)30 | Mix.Tasks.Release 31 | 32 |
33 | 34 | 45 | 46 | 47 |Build a release for the current mix application.
49 |Examples
50 |# Build a release using defaults
51 | mix release
52 |
53 | # Pass args to erlexec when running the release
54 | mix release --erl="-env TZ UTC"
55 |
56 | # Enable dev mode. Make changes, compile using MIX_ENV=prod
57 | # and execute your release again to pick up the changes
58 | mix release --dev
59 |
60 | # Set the verbosity level
61 | mix release --verbosity=[silent|quiet|normal|verbose]You may pass any number of arguments as needed. Make sure you pass arguments
63 | using --key=value, not --key value, as the args may be interpreted incorrectly
64 | otherwise.
Summary↑
73 || run(args) | 76 | 77 |Callback implementation of |
79 |
80 |
Functions
90 |Callback implementation of Mix.Task.run/1.
30 | Mix.Tasks.Release.Clean 31 | 32 |
33 | 34 | 45 | 46 | 47 |Clean up any release-related files.
49 |Examples
50 |# Cleans the release for the current version of the project
51 | mix release.clean
52 |
53 | # Remove all files generated by exrm, including releases
54 | mix release.clean --implode
55 |
56 | # Implode, but do not confirm (DANGEROUS)
57 | mix release.clean --implode --no-confirmSummary↑
66 || do_cleanup(atom1) | 69 | 70 ||
| do_run(args) | 73 | 74 ||
| run(args) | 77 | 78 |Callback implementation of |
80 |
81 |
Functions
91 |Callback implementation of Mix.Task.run/1.
30 | ReleaseManager.Plugin.Consolidation 31 | 32 |
33 | 34 | 45 | 46 | 47 | 48 | 49 | 50 | 51 |Summary↑
52 || after_cleanup() | 55 | 56 ||
| after_release() | 59 | 60 |Callback implementation of |
62 |
63 |
| before_release(config) | 66 | 67 |Callback implementation of |
69 |
70 |
Functions
80 |Callback implementation of ReleaseManager.Plugin.after_release/1.
Callback implementation of ReleaseManager.Plugin.before_release/1.
30 | ReleaseManager.Plugin.Conform 31 | 32 |
33 | 34 | 45 | 46 | 47 |Generates a .conf for your release
49 |This plugin ensures that your application has a .schema.exs
50 | and .conf file for setting up configuration via the conform
51 | library. This .conf file then offers a simplified interface
52 | for sysadmins and other deployment staff for easily configuring
53 | your release in production.
Summary↑
62 || after_cleanup() | 65 | 66 ||
| after_release() | 69 | 70 |Callback implementation of |
72 |
73 |
| before_release(config) | 76 | 77 |Callback implementation of |
79 |
80 |
Functions
90 |Callback implementation of ReleaseManager.Plugin.after_release/1.
Callback implementation of ReleaseManager.Plugin.before_release/1.
81 |
82 | {# SIDE NAV, TOGGLES ON MOBILE #}
83 |
102 |
103 |
104 |
105 | {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
106 |
110 |
111 |
112 | {# PAGE CONTENT #}
113 |
124 |
125 |
126 | {% include "versions.html" %}
127 |
128 | {% if not embedded %}
129 |
130 |
139 | {%- for scriptfile in script_files %}
140 |
141 | {%- endfor %}
142 |
143 | {% endif %}
144 |
145 | {# RTD hosts this file, so just load on non RTD builds #}
146 | {% if not READTHEDOCS %}
147 |
148 | {% endif %}
149 |
150 | {# STICKY NAVIGATION #}
151 | {% if theme_sticky_navigation %}
152 |
157 | {% endif %}
158 |
159 | {%- block footer %} {% endblock %}
160 |
161 |
162 |
163 |
--------------------------------------------------------------------------------
/doc/js/full_list.js:
--------------------------------------------------------------------------------
1 | var inSearch = null;
2 | var defaultSearchItemTimeOut = 0; //set to "0" if not testing
3 | var searchIndex = 0;
4 | var searchCache = [];
5 | var searchString = '';
6 | var regexSearchString = '';
7 | var caseSensitiveMatch = false;
8 | var ignoreKeyCodeMin = 8;
9 | var ignoreKeyCodeMax = 46;
10 | var commandKey = 91;
11 |
12 | RegExp.escape = function(text) {
13 | return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
14 | }
15 |
16 | function fullListSearch() {
17 | // generate cache
18 | searchCache = [];
19 | $('#full_list li').each(function() {
20 | var link = $(this).find('a.object_link:first');
21 | if ( link.attr('title') ) {
22 | var fullName = link.attr('title').split(' ')[0];
23 | searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
24 | }
25 | });
26 |
27 | $('#search input').keypress(function (e) {
28 | if (e.which == 13) {
29 | $('#full_list li.found:first').find('a.object_link:first').click();
30 | }
31 | });
32 |
33 | //$('#search input').keyup(function(evnt) {
34 | $('#search input').bind("keyup search reset", function(evnt) {
35 | if ((evnt.keyCode > ignoreKeyCodeMin && evnt.keyCode < ignoreKeyCodeMax)
36 | || evnt.keyCode == commandKey) {
37 | return;
38 | }
39 |
40 | $('#search').addClass('loading');
41 | searchString = this.value;
42 | caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
43 | regexSearchString = RegExp.escape(searchString);
44 | if (searchString === "") {
45 | showAllResults();
46 | }
47 | else {
48 | if (inSearch) {
49 | clearTimeout(inSearch);
50 | }
51 | searchIndex = 0;
52 | lastRowClass = '';
53 | $('#content').addClass('in_search');
54 | $('#no_results').text('');
55 | searchItem();
56 | }
57 | });
58 |
59 | $('#search input').focus();
60 | }
61 |
62 | function showAllResults() {
63 | clearTimeout(inSearch);
64 | inSearch = defaultSearchItemTimeOut;
65 | $('.search_uncollapsed').removeClass('search_uncollapsed');
66 | $('#content').removeClass('in_search');
67 | $('#full_list li').removeClass('found').each(function() {
68 | var link = $(this).find('a.object_link:first');
69 | link.text(link.text());
70 | });
71 | if (clicked) {
72 | clicked.parents('li').each(function() {
73 | $(this).removeClass('collapsed').prev().removeClass('collapsed');
74 | });
75 | }
76 | $('#no_results').text('');
77 | $('#search').removeClass('loading');
78 | highlight();
79 | }
80 |
81 | var lastRowClass = '';
82 | function searchItem() {
83 | for (var i = 0; i < searchCache.length / 50; i++) {
84 | var item = searchCache[searchIndex];
85 | var searchName = (searchString.indexOf('.') != -1 ? item.fullName : item.name);
86 | var matchString = regexSearchString;
87 | var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
88 | if (searchName.match(matchRegexp) == null) {
89 | item.node.removeClass('found');
90 | }
91 | else {
92 | item.node.addClass('found');
93 | item.node.parents('li').addClass('search_uncollapsed');
94 | item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
95 | lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
96 | item.link.html(item.name.replace(matchRegexp, "$&"));
97 | }
98 |
99 | if (searchCache.length === searchIndex + 1) {
100 | searchDone();
101 | return;
102 | }
103 | else {
104 | searchIndex++;
105 | }
106 | }
107 | inSearch = setTimeout('searchItem()', defaultSearchItemTimeOut);
108 | }
109 |
110 | function searchDone() {
111 | highlight(true);
112 | if ($('#full_list li.found').size() === 0) {
113 | $('#no_results').text('No results were found.').hide().fadeIn();
114 | }
115 | else {
116 | $('#no_results').text('');
117 | }
118 |
119 | $('#search').removeClass('loading');
120 | clearTimeout(inSearch);
121 | inSearch = null;
122 | }
123 |
124 | clicked = null;
125 | function linkList() {
126 | $('#full_list li, #full_list li a:last').click(function(evt) {
127 | if ($(this).hasClass('toggle')) {
128 | return true;
129 | }
130 |
131 | if (this.tagName.toLowerCase() == "li") {
132 | var toggle = $(this).children('a.toggle');
133 | if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
134 | toggle.click();
135 | return false;
136 | }
137 | }
138 |
139 | if (clicked) {
140 | clicked.removeClass('clicked');
141 | }
142 |
143 | var win = window.top.frames.main ? window.top.frames.main : window.parent;
144 | if (this.tagName.toLowerCase() == "a") {
145 | clicked = $(this).parent('li').addClass('clicked');
146 | win.location = this.href;
147 | }
148 | else {
149 | clicked = $(this).addClass('clicked');
150 | win.location = $(this).find('a:last').attr('href');
151 | }
152 |
153 | return false;
154 | });
155 | }
156 |
157 | function collapse() {
158 | $('#full_list a.toggle').click(function() {
159 | $(this).parent().toggleClass('collapsed').next().toggleClass('collapsed');
160 | highlight();
161 | return false;
162 | });
163 |
164 | $('#full_list > li.node').each(function() {
165 | $(this).addClass('collapsed').next('li.docs').addClass('collapsed');
166 | });
167 |
168 | highlight();
169 | }
170 |
171 | function highlight(no_padding) {
172 | var n = 1;
173 | $('#full_list a.object_link:visible').each(function() {
174 | var next = n == 1 ? 2 : 1;
175 | var li = $(this).parent();
176 | li.removeClass("r" + next).addClass("r" + n);
177 | no_padding ? li.addClass("no_padding") : li.removeClass("no_padding");
178 | n = next;
179 | });
180 | }
181 |
182 | function escapeShortcut() {
183 | $(document).keydown(function(evt) {
184 | if (evt.which == 27) {
185 | $('#search_frame', window.top.document).slideUp(100);
186 | $('#search a', window.top.document).removeClass('active inactive');
187 | $(window.top).focus();
188 | }
189 | });
190 | }
191 |
192 | $(escapeShortcut);
193 | $(fullListSearch);
194 | $(linkList);
195 | $(collapse);
--------------------------------------------------------------------------------
/doc/css/full_list.css:
--------------------------------------------------------------------------------
1 | /*** DOCUMENT STRUCTURE: list_template.eex ***
2 | body.frames
3 | section#content [.in_search]
4 | h1#full_list_header
5 | h2#sub_list_header
6 | div#nav
7 | div#search [.loading] > input#search_field
8 | ul#full_list
9 | li.node [.collpased, .search_uncollapsed, .found]
10 | a.toggle
11 | a.object_link
12 | span.node_name
13 | li.docs [.collpased, .search_uncollapsed, .found]
14 | a.toggle
15 | a.object_link
16 | span.node_name
17 | ...
18 | div.no_results
19 | */
20 |
21 | /* DOCUMENT STYLES */
22 | body {
23 | font: 13px "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
24 | height: 101%;
25 | margin: 0;
26 | overflow-x: hidden;
27 | }
28 | h1 {
29 | font-size: 1.4em;
30 | margin: 0;
31 | padding: 12px 10px 0;
32 | }
33 | a:link, a:visited {
34 | color: #05a;
35 | text-decoration: none;
36 | }
37 | li {
38 | color: #888;
39 | cursor: pointer;
40 | }
41 | li:hover {
42 | background: #ddd;
43 | }
44 | span.node_name {
45 | font-size: 0.8em;
46 | }
47 |
48 | /*** LEFT FRAME ***/
49 | .frames li {
50 | white-space: nowrap;
51 | cursor: default;
52 | }
53 |
54 | /* HEADERS */
55 | .frames h1 {
56 | margin-top: 0;
57 | }
58 | .frames h2 {
59 | font-size: 0.9em;
60 | margin: 5px 10px 15px;
61 | }
62 |
63 | /* NAVIGATION BAR */
64 | .nav {
65 | margin: 0 0 10px 5px;
66 | font-size: 0.9em;
67 | color: #aaa;
68 | }
69 | .nav a:link,
70 | .nav a:visited {
71 | color: #358;
72 | }
73 | .nav a:hover {
74 | background: transparent;
75 | color: #5af;
76 | }
77 | .nav span {
78 | border-left: 1px solid #ccc;
79 | padding: 0 3px 0 5px;
80 | }
81 | .nav span:first-child {
82 | border-left: 0;
83 | border-radius: 3px;
84 | }
85 | .nav span.selected {
86 | text-decoration: underline;
87 | }
88 |
89 | /* SEARCH BOX */
90 | #search {
91 | font-size: 0.9em;
92 | color: #888;
93 | margin: 3px; margin-left: 10px;
94 | padding-left: 0; padding-right: 24px;
95 | }
96 | #search_field {
97 | width: 180px;
98 | margin-right:35px;
99 | border:2px solid #d8d8e5;
100 | padding:2px 4px;
101 | -moz-box-sizing: border-box;
102 | }
103 | #search.loading {
104 | background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat 188px center;
105 | min-height:18px;
106 | }
107 | #content #no_results {
108 | margin-left: 7px;
109 | padding: 7px 12px;
110 | }
111 |
112 | /* FULL LIST OF CONTENTS */
113 | #full_list {
114 | list-style: none;
115 | margin-left: 0;
116 | padding: 0;
117 | }
118 | #full_list ul {
119 | margin:0;
120 | padding: 0;
121 | }
122 | #full_list li {
123 | margin: 0;
124 | padding: 5px 5px 5px 0;
125 | font-size: 1.1em;
126 | list-style: none;
127 | }
128 | #full_list li.node {
129 | padding-left: 25px;
130 | }
131 | #full_list li.docs {
132 | padding:0;
133 | }
134 | #full_list li.docs li {
135 | padding-left: 25px;
136 | }
137 | #full_list li span.node_name {
138 | display: none;
139 | }
140 | #full_list .no_padding {
141 | padding-left:0;
142 | }
143 | /* while searching */
144 | .in_search #full_list ul {
145 | margin-left:0;}
146 | .in_search #full_list li {
147 | display: none;
148 | }
149 | .in_search #full_list li.found {
150 | display: list-item;
151 | }
152 | .in_search #full_list li a.toggle {
153 | display: none;
154 | }
155 | .in_search #full_list li span.node_name {
156 | display: block;
157 | }
158 | /* collapsed menu */
159 | #full_list .search_uncollapsed,
160 | #full_list .search_uncollapsed ul {
161 | display:block !important;
162 | }
163 | #full_list ul.collapsed ul,
164 | #full_list ul.collapsed li,
165 | #full_list li.collapsed ul,
166 | #full_list li.collapsed li {
167 | display: none;
168 | }
169 | #full_list ul.search_uncollapsed li.found,
170 | #full_list li.search_uncollapsed li.found {
171 | display: list-item;
172 | }
173 | li.deprecated {
174 | text-decoration: line-through;
175 | font-style: italic;
176 | }
177 | li.r1 {
178 | background: #f0f0f0;
179 | }
180 | li.r2 {
181 | background: #fafafa;
182 | }
183 | /* link properties */
184 | li a.toggle {
185 | display: block;
186 | float: left;
187 | position: relative;
188 | left: -5px;
189 | top: 4px;
190 | width: 10px;
191 | height: 9px;
192 | margin-left: -10px;
193 | text-indent: -999px;
194 | background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left;
195 | cursor: default;
196 | }
197 | li.collapsed a.toggle {
198 | opacity: 0.5;
199 | cursor: default;
200 | background-position: top left;
201 | }
202 | li.clicked {
203 | background: #05a;
204 | color: #ccc;
205 | }
206 | li.clicked a:link, li.clicked a:visited {
207 | color: #eee;
208 | }
209 | li.clicked a.toggle {
210 | opacity: 0.5;
211 | background-position: bottom right;
212 | }
213 | li.collapsed.clicked a.toggle {
214 | background-position: top right;
215 | }
216 |
--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
1 | # Makefile for Sphinx documentation
2 | #
3 |
4 | # You can set these variables from the command line.
5 | SPHINXOPTS =
6 | SPHINXBUILD = sphinx-build
7 | PAPER =
8 | BUILDDIR = build
9 |
10 | # User-friendly check for sphinx-build
11 | ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12 | $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13 | endif
14 |
15 | # Internal variables.
16 | PAPEROPT_a4 = -D latex_paper_size=a4
17 | PAPEROPT_letter = -D latex_paper_size=letter
18 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19 | # the i18n builder cannot share the environment and doctrees with the others
20 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
21 |
22 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23 |
24 | help:
25 | @echo "Please use \`make
114 |
122 |
123 |
115 | {% include "breadcrumbs.html" %}
116 |
121 |
117 | {% block body %}{% endblock %}
118 |
119 | {% include "footer.html" %}
120 |
51 |
84 | {%- endif %}
85 | {%- endmacro %}
86 |
87 | {%- macro script() %}
88 |
97 | {%- for scriptfile in script_files %}
98 |
99 | {%- endfor %}
100 | {%- endmacro %}
101 |
102 | {%- macro css() %}
103 |
104 |
105 | {%- for cssfile in css_files %}
106 |
107 | {%- endfor %}
108 | {%- endmacro %}
109 |
110 |
111 |
112 |
113 | {{ metatags }}
114 | {%- block htmltitle %}
115 |
52 | {%- block sidebarlogo %}
53 | {%- if logo %}
54 |
57 | {%- endif %}
58 | {%- endblock %}
59 | {%- if sidebars != None %}
60 | {#- new style sidebar: explicitly include/exclude templates #}
61 | {%- for sidebartemplate in sidebars %}
62 | {%- include sidebartemplate %}
63 | {%- endfor %}
64 | {%- else %}
65 | {#- old style sidebars: using blocks -- should be deprecated #}
66 | {%- block sidebartoc %}
67 | {%- include "localtoc.html" %}
68 | {%- endblock %}
69 | {%- block sidebarrel %}
70 | {%- include "relations.html" %}
71 | {%- endblock %}
72 | {%- block sidebarsourcelink %}
73 | {%- include "sourcelink.html" %}
74 | {%- endblock %}
75 | {%- if customsidebar %}
76 | {%- include customsidebar %}
77 | {%- endif %}
78 | {%- block sidebarsearch %}
79 | {%- include "searchbox.html" %}
80 | {%- endblock %}
81 | {%- endif %}
82 |
83 |
164 | {%- block document %}
165 |
181 | {%- endblock %}
182 |
183 | {%- block relbar2 %}{{ relbar() }}{% endblock %}
184 |
185 | {%- block footer %}
186 |
201 |
166 | {%- if render_sidebar %}
167 |
176 | {%- endblock %}
177 |
178 | {%- block sidebar2 %}{{ sidebar() }}{% endblock %}
179 |
180 |
168 | {%- endif %}
169 |
174 | {%- endif %}
175 |
170 | {% block body %} {% endblock %}
171 |
172 | {%- if render_sidebar %}
173 | asdf asdf asdf asdf 22
202 | {%- endblock %} 203 | 204 | 205 | 206 | -------------------------------------------------------------------------------- /doc/ReleaseManager.Plugin.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |30 | ReleaseManager.Plugin 31 | 32 | behaviour 33 | 34 |
35 | 36 | 49 | 50 | 51 |This module provide a simple way to add additional steps to 53 | the release task.
54 |You can define your own plugins using the sample definition below. Note that
55 | the module namespace must be nested under ReleaseManager.Plugin.*.
defmodule ReleaseManager.Plugin.Hello do
57 | use ReleaseManager.Plugin
58 |
59 | def before_release(%Config{} = config) do
60 | info "This is executed just prior to compiling the release"
61 | end
62 |
63 | def after_release(%Config{} = config) do
64 | info "This is executed just after compiling the release"
65 | end
66 |
67 | def after_cleanup(_args) do
68 | info "This is executed just after running cleanup"
69 | end
70 | endA couple things are imported or aliased for you. Those things are:
72 |-
73 |
- The ReleaseManager.Config struct is aliased for you to just Config 74 | 75 |
debug/1,info/1,warn/1,notice/1, anderror/1are imported for you. 76 | These should be used to do any output for the user. 77 |
78 |
before_release/1 and after_release/1 are required callbacks, and will each be passed a
80 | Config struct, containing the configuration for the release task. You can choose
81 | to return the config struct modified or unmodified, or not at all. In the former case,
82 | any modifications you made will be passed on to the remaining plugins and the final
83 | release task. The required callback after_cleanup/1 is passed the command line arguments.
84 | The return value is not used.
All plugins are executed just prior, and just after compiling the release, as the name of
86 | the callbacks reflect. The before_release/1 callback is called after some internal tasks,
87 | such as generating the sys.config and others.
Summary↑
96 || load_all() | 99 | 100 |Loads all plugins in all code paths 101 | |
102 |
103 |
| load_plugins(paths) | 106 | 107 |Loads all plugins in the given |
109 |
110 |
Functions
120 |Specs:
131 |-
132 |
133 |
- load_all :: [] | [atom] 134 | 135 |
Loads all plugins in all code paths.
139 | 140 |Specs:
154 |-
155 |
156 |
- load_plugins([binary]) :: [] | [atom] 157 | 158 |
Loads all plugins in the given paths.
Callbacks
175 |Specs:
186 |-
187 |
188 |
- after_release(ReleaseManager.Config.t) :: any 189 | 190 |
Specs:
208 |-
209 |
210 |
- before_release(ReleaseManager.Config.t) :: any 211 | 212 |
A plugin needs to implement before_release/1, and after_release/1
216 | both of which receive a %ReleaseManager.Config struct