harbored-mod 0.2.1

A documentation generator for D with support for both DDoc and Markdown in documentation comments.


To use this package, put the following dependency into your project's dependencies section:

dub.json
dub.sdl

<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" /> <title>harbored-mod</title> <style type="text/css">

/* :Author: David Goodger (goodger@python.org) :Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $ :Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to customize this style sheet. */

/ used to remove borders from tables and images / .borderless, table.borderless td, table.borderless th { border: 0 }

table.borderless td, table.borderless th { /* Override padding for "table.docutils td" with "! important".

 The right padding separates the table cells. */

padding: 0 0.5em 0 0 ! important }

.first { / Override more specific margin styles with "! important". / margin-top: 0 ! important }

.last, .with-subtitle { margin-bottom: 0 ! important }

.hidden { display: none }

a.toc-backref { text-decoration: none ; color: black }

blockquote.epigraph { margin: 2em 5em ; }

dl.docutils dd { margin-bottom: 0.5em }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] { overflow: hidden; }

/ Uncomment (and remove this text!) to get bold-faced definition list terms dl.docutils dt { font-weight: bold } /

div.abstract { margin: 2em 5em }

div.abstract p.topic-title { font-weight: bold ; text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error, div.hint, div.important, div.note, div.tip, div.warning { margin: 2em ; border: medium outset ; padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title, div.important p.admonition-title, div.note p.admonition-title, div.tip p.admonition-title { font-weight: bold ; font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title, div.danger p.admonition-title, div.error p.admonition-title, div.warning p.admonition-title, .code .error { color: red ; font-weight: bold ; font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in compound paragraphs. div.compound .compound-first, div.compound .compound-middle { margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle { margin-top: 0.5em } */

div.dedication { margin: 2em 5em ; text-align: center ; font-style: italic }

div.dedication p.topic-title { font-weight: bold ; font-style: normal }

div.figure { margin-left: 2em ; margin-right: 2em }

div.footer, div.header { clear: both; font-size: smaller }

div.line-block { display: block ; margin-top: 1em ; margin-bottom: 1em }

div.line-block div.line-block { margin-top: 0 ; margin-bottom: 0 ; margin-left: 1.5em }

div.sidebar { margin: 0 0 0.5em 1em ; border: medium outset ; padding: 1em ; background-color: #ffffee ; width: 40% ; float: right ; clear: right }

div.sidebar p.rubric { font-family: sans-serif ; font-size: medium }

div.system-messages { margin: 5em }

div.system-messages h1 { color: red }

div.system-message { border: medium outset ; padding: 1em }

div.system-message p.system-message-title { color: red ; font-weight: bold }

div.topic { margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { margin-top: 0.4em }

h1.title { text-align: center }

h2.subtitle { text-align: center }

hr.docutils { width: 75% }

img.align-left, .figure.align-left, object.align-left { clear: left ; float: left ; margin-right: 1em }

img.align-right, .figure.align-right, object.align-right { clear: right ; float: right ; margin-left: 1em }

img.align-center, .figure.align-center, object.align-center { display: block; margin-left: auto; margin-right: auto; }

.align-left { text-align: left }

.align-center { clear: both ; text-align: center }

.align-right { text-align: right }

/ reset inner alignment in figures / div.align-right { text-align: inherit }

/ div.align-center { / / text-align: left } */

ol.simple, ul.simple { margin-bottom: 1em }

ol.arabic { list-style: decimal }

ol.loweralpha { list-style: lower-alpha }

ol.upperalpha { list-style: upper-alpha }

ol.lowerroman { list-style: lower-roman }

ol.upperroman { list-style: upper-roman }

p.attribution { text-align: right ; margin-left: 50% }

p.caption { font-style: italic }

p.credits { font-style: italic ; font-size: smaller }

p.label { white-space: nowrap }

p.rubric { font-weight: bold ; font-size: larger ; color: maroon ; text-align: center }

p.sidebar-title { font-family: sans-serif ; font-weight: bold ; font-size: larger }

p.sidebar-subtitle { font-family: sans-serif ; font-weight: bold }

p.topic-title { font-weight: bold }

pre.address { margin-bottom: 0 ; margin-top: 0 ; font: inherit }

pre.literal-block, pre.doctest-block, pre.math, pre.code { margin-left: 2em ; margin-right: 2em }

pre.code .ln { color: grey; } / line numbers / pre.code, code { background-color: #eeeeee } pre.code .comment, code .comment { color: #5C6576 } pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } pre.code .literal.string, code .literal.string { color: #0C5404 } pre.code .name.builtin, code .name.builtin { color: #352B84 } pre.code .deleted, code .deleted { background-color: #DEB0A1} pre.code .inserted, code .inserted { background-color: #A3D289}

span.classifier { font-family: sans-serif ; font-style: oblique }

span.classifier-delimiter { font-family: sans-serif ; font-weight: bold }

span.interpreted { font-family: sans-serif }

span.option { white-space: nowrap }

span.pre { white-space: pre }

span.problematic { color: red }

span.section-subtitle { / font-size relative to parent (h1..h6 element) / font-size: 80% }

table.citation { border-left: solid 1px gray; margin-left: 1px }

table.docinfo { margin: 2em 4em }

table.docutils { margin-top: 0.5em ; margin-bottom: 0.5em }

table.footnote { border-left: solid 1px black; margin-left: 1px }

table.docutils td, table.docutils th, table.docinfo td, table.docinfo th { padding-left: 0.5em ; padding-right: 0.5em ; vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name { font-weight: bold ; text-align: left ; white-space: nowrap ; padding-left: 0 }

/ "booktabs" style (no vertical lines) / table.docutils.booktabs { border: 0px; border-top: 2px solid; border-bottom: 2px solid; border-collapse: collapse; } table.docutils.booktabs * { border: 0px; } table.docutils.booktabs th { border-bottom: thin solid; text-align: left; }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { font-size: 100% }

ul.auto-toc { list-style-type: none }

</style> </head> <body> <div class="document" id="harbored-mod"> <h1 class="title">harbored-mod</h1>

<p><strong>NOTE</strong>: the default output format has been changed to one file per aggregate instead of one file per symbol. Use <cite>--format=html-simple</cite> to get the previous default output format.</p> <div class="section" id="introduction"> <h1>Introduction</h1> <p>Documentation generator for <a class="reference external" href="http://dlang.org">D</a> with Markdown support, based on <a class="reference external" href="https://github.com/economicmodeling/harbored">harbored</a>.</p> <p>Harbored-mod supports both <a class="reference external" href="http://dlang.org/ddoc.html">DDoc</a> and <a class="reference external" href="http://en.wikipedia.org/wiki/Markdown">Markdown</a> in documentation comments, but DDoc takes precedence. This means that there are slight <a class="reference internal" href="#differences">differences</a> from standard Markdown.</p> </div> <div class="section" id="examples-of-generated-documentation"> <h1>Examples of generated documentation</h1> <ul class="simple"> <li><a class="reference external" href="http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity.html">Public imports in a package.d</a></li> <li><a class="reference external" href="http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/entitymanager/EntityManager.html">Class with a template parameter, member functions and aliases</a></li> <li><a class="reference external" href="http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/componenttypeinfo/ImmutableRawComponent.html">Simple DDoc SeeAlso: section</a></li> <li><a class="reference external" href="http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/processtypeinfo.html#prioritizeProcessOverloads">Note: DDoc section with some markdown</a> (<strong>bold</strong>, `code`, <em>italic</em>)</li> </ul> </div> <div class="section" id="getting-started"> <h1>Getting started</h1> <div class="note"> <p class="first admonition-title">Note</p> <p class="last">There are experimental binaries for some platforms on the <a class="reference external" href="https://github.com/kiith-sa/harbored-mod/releases">releases</a> page. If you're using a binary, you can jump to <strong>Setting up</strong>.</p> </div> <div class="section" id="building-with-dub"> <h2>Building with DUB</h2> <p>If you have <a class="reference external" href="http://code.dlang.org">DUB</a> installed:</p> <ul> <li><p class="first">get harbored-mod:</p> <pre class="literal-block"> git clone https://github.com/kiith-sa/harbored-mod.git </pre> </li> <li><p class="first">Go into the directory harbored-mod was cloned into:</p> <pre class="literal-block"> cd harbored-mod </pre> </li> <li><p class="first">Compile:</p> <pre class="literal-block"> dub build </pre> </li> </ul> </div> <div class="section" id="building-with-make"> <h2>Building with Make</h2> <p>This assumes you are using the DMD compiler. Currently, harbored-mod uses a Makefile hardcoded to DMD. Eventually it will be moved to <a class="reference external" href="http://code.dlang.org">dub</a>.</p> <ul> <li><p class="first">get harbored-mod and its dependencies:</p> <pre class="literal-block"> git clone --recursive https://github.com/kiith-sa/harbored-mod.git </pre> </li> <li><p class="first">Go into the directory harbored-mod was cloned into:</p> <pre class="literal-block"> cd harbored-mod </pre> </li> <li><p class="first">Compile:</p> <pre class="literal-block"> make </pre> </li> </ul> </div> <div class="section" id="setting-up"> <h2>Setting up</h2> <p>At this point you should have a binary called <tt class="docutils literal">hmod</tt> in the <tt class="docutils literal">bin</tt> directory.</p> <ul> <li><p class="first">Modify your <tt class="docutils literal">PATH</tt> to point to the <tt class="docutils literal">bin</tt> directory or copy the binary into your project.</p> </li> <li><p class="first">From your project's directory, run <tt class="docutils literal">hmod</tt>. This assumes your source code is in the <tt class="docutils literal">./source</tt> subdirectory (as is often the case with <tt class="docutils literal">dub</tt> projects) and that the <tt class="docutils literal">hmod</tt> binary is in <tt class="docutils literal">PATH</tt>, prepend with <tt class="docutils literal">./</tt> if it's in the project directory).:</p> <pre class="literal-block"> hmod source </pre> <p>This will write generate documentation to the <tt class="docutils literal">./doc</tt> subdirectory. See <tt class="docutils literal">./doc/index.html</tt>. Note that the main page will be blank, although you should see a list of all modules on the left.</p> <p>To further tweak the documentation, generate the default configuration file:</p> <pre class="literal-block"> hmod -g </pre> <p>This will generate a file called <tt class="docutils literal">hmod.cfg</tt> in the current directory. Harbored-mod looks for this file in the directory it's running from, and if present, loads configuration options such as main page content, style, files to exclude from documentation generation, and so on. See comments in <tt class="docutils literal">hmod.cfg</tt> for more information.</p> </li> </ul> </div> </div> <div class="section" id="features"> <h1>Features</h1> <ul class="simple"> <li>Supports DDoc <strong>and</strong> (most, see <a class="reference internal" href="#differences">differences</a>) Markdown syntax</li> <li>Sensible defaults (get decent documentation without tweaking any settings)</li> <li>Automatic cross-referencing in code blocks and <tt class="docutils literal">inline code</tt></li> <li>Very fast; it takes <tt class="docutils literal">0.11s</tt> to generate API documentation <a class="reference external" href="http://defenestrate.eu/docs/tharsis-core/api/index.html">documentation</a> of <a class="reference external" href="https://github.com/kiith-sa/tharsis-core">tharsis-core</a> on a 3.4GHz Core i5 (Ivy Bridge).</li> <li>All command-line options can be set in a config file (<tt class="docutils literal">hmod.cfg</tt>) so just <tt class="docutils literal">hmod</tt> is enough to generate documentation</li> <li>Generates one file per module/<tt class="docutils literal">class</tt>/<tt class="docutils literal">struct</tt>/<tt class="docutils literal">enum</tt>/etc. by default, as opposed to one file per module (old Phobos documentation) or one file per symbol (<tt class="docutils literal">ddox</tt>).</li> <li>File paths can be made compatible with <a class="reference external" href="https://github.com/rejectedsoftware/ddox">ddox</a> using the non-default <tt class="docutils literal"><span class="pre">--format=html-simple</span></tt> option</li> <li>Generated HTML enriched by classes to be more tweakable with CSS</li> <li>Custimizable main page, table of contents and style (CSS)</li> <li>Can exclude modules/packages from documentation by their name (not file name)</li> <li>Generated docs are usable without JavaScript (e.g. NoScript), JS may used for optional functionality</li> <li><strong>Only</strong> generates HTML, and is unlikely to support any other formats</li> </ul> </div> <div class="section" id="differences-from-vanilla-markdown"> <span id="differences"></span><h1>Differences from vanilla Markdown:</h1> <ul> <li><p class="first"><tt class="docutils literal"><span class="pre">---</span></tt> will not generate a horizontal line, as it is used for DDoc blocks.</p> <p>Use <tt class="docutils literal">- - -</tt> instead. This is still standard Markdown.</p> </li> <li><p class="first"><em>emphasis</em> can be denoted by <tt class="docutils literal">*</tt>, but not by <tt class="docutils literal"></tt> (this would break snake_case names).</p> </li> <li><p class="first">This does not work (again because DDoc uses <tt class="docutils literal"><span class="pre">---</span></tt> to mark code blocks):</p> <pre class="literal-block"> Subheading

</pre> <p>Instead, use either (standard Markdown):</p> <pre class="literal-block">

Subheading

</pre> <p>Or (non-standard):</p> <pre class="literal-block"> Subheading


</pre> </li> </ul> </div> <div class="section" id="directory-structure"> <h1>Directory structure</h1> <table border="1" class="docutils"> <colgroup> <col width="17%" /> <col width="83%" /> </colgroup> <thead valign="bottom"> <tr><th class="head">Directory</th> <th class="head">Contents</th> </tr> </thead> <tbody valign="top"> <tr><td><tt class="docutils literal">./</tt></td> <td>This README, Makefile, license.</td> </tr> <tr><td><tt class="docutils literal">./bin</tt></td> <td>Harbored-mod binaries when compiled.</td> </tr> <tr><td><tt class="docutils literal">./dmarkdown</tt></td> <td><a class="reference external" href="https://github.com/kiith-sa/dmarkdown">dmarkdown</a> dependency.</td> </tr> <tr><td><tt class="docutils literal">./libddoc</tt></td> <td><a class="reference external" href="https://github.com/economicmodeling/libddoc">libddoc</a> dependency.</td> </tr> <tr><td><tt class="docutils literal">./libdparse</tt></td> <td><a class="reference external" href="https://github.com/Hackerpilot/libdparse">libdparse</a> dependency.</td> </tr> <tr><td><tt class="docutils literal">./src</tt></td> <td>Source code.</td> </tr> <tr><td><tt class="docutils literal">./strings</tt></td> <td>Files compiled into Harbored-mod to be used in generated documentation (e.g. the default CSS style).</td> </tr> </tbody> </table> </div> <div class="section" id="license"> <h1>License</h1> <p>Harbored-mod is released under the terms of the <a class="reference external" href="http://www.boost.org/LICENSE10.txt">Boost Software License 1.0</a>. This license allows you to use the source code in your own projects, open source or proprietary, and to modify it to suit your needs. However, in source distributions, you have to preserve the license headers in the source code and the accompanying license file.</p> <p>Full text of the license can be found in file <tt class="docutils literal">LICENSE10.txt</tt> and is also displayed here:</p> <pre class="literal-block"> Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization obtaining a copy of the software and accompanying documentation covered by this license (the "Software") to use, reproduce, display, distribute, execute, and transmit the Software, and to prepare derivative works of the Software, and to permit third-parties to whom the Software is furnished to do so, all subject to the following:

The copyright notices in the Software and this entire statement, including the above license grant, this restriction and the following disclaimer, must be included in all copies of the Software, in whole or in part, and all derivative works of the Software, unless such copies or derivative works are solely in the form of machine-executable object code generated by a source language processor.

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, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </pre> </div> <div class="section" id="credits"> <h1>Credits</h1> <p>Harbored-mod is based on <a class="reference external" href="https://github.com/economicmodeling/harbored">harbored</a> by Brian Schott, with modifications by Ferdinand Majerech aka Kiith-Sa kiithsacmp[AT]gmail.com.</p> <p>Harbored-mod was created as a documentation generator for the <a class="reference external" href="http://www.dlang.org">D programming language</a>. See more D projects at <a class="reference external" href="http://code.dlang.org">code.dlang.org</a>.</p> </div> </div> </body> </html>

Authors:
  • Brian Schott
  • Ferdinand Majerech
Dependencies:
dmarkdown, libddoc, libdparse
Versions:
0.2.1 2017-May-16
~master 2018-Jun-29
Show all 2 versions
Download Stats:
  • 0 downloads today

  • 0 downloads this week

  • 0 downloads this month

  • 8 downloads total

Score:
0.0
Short URL:
harbored-mod.dub.pm