231 lines
12 KiB
HTML
231 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
|
<head>
|
|
<meta charset="utf-8"/>
|
|
<title>Clojure Guides: Generating Documentation</title>
|
|
|
|
|
|
<meta name="description" content="This guide notes some commonly-used tools for generating project
|
|
documentation.This work is licensed under a Creative Commons
|
|
Attribution 3.0 Unported License (including images &
|
|
stylesheets). The source is available on
|
|
Github.">
|
|
|
|
<meta property="og:description" content="This guide notes some commonly-used tools for generating project
|
|
documentation.This work is licensed under a Creative Commons
|
|
Attribution 3.0 Unported License (including images &
|
|
stylesheets). The source is available on
|
|
Github.">
|
|
|
|
<meta property="og:url" content="https://clojure-doc.github.io/articles/ecosystem/generating_documentation/" />
|
|
<meta property="og:title" content="Generating Documentation" />
|
|
<meta property="og:type" content="article" />
|
|
|
|
<link rel="canonical" href="https://clojure-doc.github.io/articles/ecosystem/generating_documentation/">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link href="https://fonts.googleapis.com/css?family=Alegreya:400italic,700italic,400,700" rel="stylesheet"
|
|
type="text/css">
|
|
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.0/css/bootstrap.min.css">
|
|
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/styles/default.min.css">
|
|
<link href="../../../css/screen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
|
|
|
|
<nav class="navbar navbar-default">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<a class="navbar-brand" href="../../../index.html">Clojure Guides</a>
|
|
</div>
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li ><a href="../../../index.html">Home</a></li>
|
|
<li><a href="https://github.com/clojure-doc/clojure-doc.github.io">Contribute</a></li>
|
|
</ul>
|
|
</div><!--/.nav-collapse -->
|
|
</div><!--/.container-fluid -->
|
|
</nav>
|
|
|
|
|
|
<div class="container">
|
|
|
|
|
|
<div class="row">
|
|
<div class="col-lg-9">
|
|
<div id="content">
|
|
|
|
<div id="custom-page">
|
|
<div id="page-header">
|
|
<h2>Generating Documentation</h2>
|
|
</div>
|
|
|
|
<p>This guide notes some commonly-used tools for generating project
|
|
documentation.</p><p>This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
|
|
Attribution 3.0 Unported License</a> (including images &
|
|
stylesheets). The source is available <a href="https://github.com/clojure-doc/clojure-doc.github.io">on
|
|
Github</a>.</p><h2 id="what-version-of-clojure-does-this-guide-cover">What Version of Clojure Does This Guide Cover?</h2><p>This guide covers Clojure 1.4.</p><h2 id="overview">Overview</h2><p>Projects commonly (hopefully?) have at least two types of
|
|
documentation:</p><ul><li>standalone
|
|
<a href="http://en.wikipedia.org/wiki/Markdown">markdown</a>-formatted docs
|
|
in the project's doc directory</li><li>docstrings</li></ul><p>There are a number of tools for generating handsome API docs from
|
|
docstrings and other project metadata.</p><h2 id="codox">Codox</h2><p>If you'd like to generate nice-looking html API docs for your library,
|
|
use <a href="https://github.com/weavejester/codox">codox</a>. Usage instructions
|
|
are in the codox readme. Running codox (it's a lein plug-in and is run
|
|
via <code>lein codox</code> in your project) will create a "doc" subdirectory
|
|
containing the resulting html.</p><h2 id="marginalia">Marginalia</h2><p>If you'd like to render API docs side-by-side with the source code
|
|
it's documenting, use <a href="https://github.com/fogus/lein-marginalia">the marginalia lein
|
|
plug-in</a>. Usage instructions
|
|
are in the readme.</p><h2 id="cadastre">Cadastre</h2><p>If you'd like to generate copious raw data from a project (which
|
|
includes docstrings as well as other metadata), have a look at
|
|
<a href="https://github.com/dakrone/cadastre">cadastre</a>.</p>
|
|
|
|
<div id="prev-next">
|
|
|
|
<a href="../libraries_authoring/index.html">« Library Development and Distribution</a>
|
|
|
|
|
|
||
|
|
|
|
|
|
<a href="../data_processing/index.html">Data Processing (Help Wanted) »</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="col-md-3">
|
|
<div id="sidebar">
|
|
<h3>Links</h3>
|
|
<ul id="links">
|
|
|
|
<li><a href="../../about/index.html">About</a></li>
|
|
|
|
<li><a href="../../content/index.html">Table of Contents</a></li>
|
|
|
|
<li><a href="../../tutorials/getting_started/index.html">Getting Started with Clojure</a></li>
|
|
|
|
<li><a href="../../tutorials/introduction/index.html">Introduction to Clojure</a></li>
|
|
|
|
<li><a href="../../tutorials/emacs/index.html">Clojure with Emacs</a></li>
|
|
|
|
<li><a href="../../tutorials/vim_fireplace/index.html">Clojure with Vim and fireplace.vim</a></li>
|
|
|
|
<li><a href="../../tutorials/eclipse/index.html">Starting with Eclipse and Counterclockwise For Clojure Development</a></li>
|
|
|
|
<li><a href="../../tutorials/basic_web_development/index.html">Basic Web Development</a></li>
|
|
|
|
<li><a href="../../tutorials/parsing_xml_with_zippers/index.html">Parsing XML in Clojure</a></li>
|
|
|
|
<li><a href="../../tutorials/growing_a_dsl_with_clojure/index.html">Growing a DSL with Clojure</a></li>
|
|
|
|
<li><a href="../../language/core_overview/index.html">Overview of clojure.core, the standard Clojure library</a></li>
|
|
|
|
<li><a href="../../language/namespaces/index.html">Clojure Namespaces and Vars</a></li>
|
|
|
|
<li><a href="../../language/collections_and_sequences/index.html">Collections and Sequences in Clojure</a></li>
|
|
|
|
<li><a href="../../language/functions/index.html">Functions in Clojure</a></li>
|
|
|
|
<li><a href="../../language/laziness/index.html">Laziness in Clojure</a></li>
|
|
|
|
<li><a href="../../language/interop/index.html">Clojure interoperability with Java</a></li>
|
|
|
|
<li><a href="../../language/macros/index.html">Clojure Macros and Metaprogramming</a></li>
|
|
|
|
<li><a href="../../language/polymorphism/index.html">Polymorphism in Clojure: Protocols and Multimethods</a></li>
|
|
|
|
<li><a href="../../language/concurrency_and_parallelism/index.html">Concurrency and Parallelism in Clojure</a></li>
|
|
|
|
<li><a href="../../language/glossary/index.html">Clojure Terminology Guide</a></li>
|
|
|
|
<li><a href="../libraries_directory/index.html">A Directory of Clojure Libraries</a></li>
|
|
|
|
<li><a href="../libraries_authoring/index.html">Library Development and Distribution</a></li>
|
|
|
|
<li><a href="index.html">Generating Documentation</a></li>
|
|
|
|
<li><a href="../data_processing/index.html">Data Processing (Help Wanted)</a></li>
|
|
|
|
<li><a href="../web_development/index.html">Web Development (Overview)</a></li>
|
|
|
|
<li><a href="../maven/index.html">How to use Maven to build Clojure projects</a></li>
|
|
|
|
<li><a href="../community/index.html">Clojure Community</a></li>
|
|
|
|
<li><a href="../user_groups/index.html">Clojure User Groups</a></li>
|
|
|
|
<li><a href="../running_cljug/index.html">Running a Clojure User Group</a></li>
|
|
|
|
<li><a href="../books/index.html">Books about Clojure and ClojureScript</a></li>
|
|
|
|
<li><a href="../../cookbooks/data_structures/index.html">Data Structures (Help wanted)</a></li>
|
|
|
|
<li><a href="../../cookbooks/strings/index.html">Strings</a></li>
|
|
|
|
<li><a href="../../cookbooks/math/index.html">Mathematics with Clojure</a></li>
|
|
|
|
<li><a href="../../cookbooks/date_and_time/index.html">Date and Time (Help wanted)</a></li>
|
|
|
|
<li><a href="../../cookbooks/files_and_directories/index.html">Working with Files and Directories in Clojure</a></li>
|
|
|
|
<li><a href="../../cookbooks/middleware/index.html">Middleware in Clojure</a></li>
|
|
|
|
<li><a href="../java_jdbc/home.html">java.jdbc - Getting Started</a></li>
|
|
|
|
<li><a href="../java_jdbc/using_sql.html">java.jdbc - Manipulating data with SQL</a></li>
|
|
|
|
<li><a href="../java_jdbc/using_ddl.html">java.jdbc - Using DDL and Metadata</a></li>
|
|
|
|
<li><a href="../java_jdbc/reusing_connections.html">java.jdbc - How to reuse database connections</a></li>
|
|
|
|
<li><a href="../core_typed/home/index.html">core.typed - User Documentation Home</a></li>
|
|
|
|
<li><a href="../core_typed/user_documentation/index.html">core.typed - User Documentation</a></li>
|
|
|
|
<li><a href="../core_typed/rationale/index.html">core.typed - Rationale</a></li>
|
|
|
|
<li><a href="../core_typed/quick_guide.html">core.typed - Quick Guide</a></li>
|
|
|
|
<li><a href="../core_typed/start/introduction_and_motivation/index.html">core.typed - Getting Started: Introduction and Motivation</a></li>
|
|
|
|
<li><a href="../core_typed/types/index.html">core.typed - Types</a></li>
|
|
|
|
<li><a href="../core_typed/start/annotations/index.html">core.typed - Annotations</a></li>
|
|
|
|
<li><a href="../core_typed/poly_fn/index.html">core.typed - Polymorphic Functions</a></li>
|
|
|
|
<li><a href="../core_typed/filters/index.html">core.typed - Filters</a></li>
|
|
|
|
<li><a href="../core_typed/mm_protocol_datatypes/index.html">core.typed - Protocols</a></li>
|
|
|
|
<li><a href="../core_typed/loops/index.html">core.typed - Looping constructs</a></li>
|
|
|
|
<li><a href="../core_typed/function_types/index.html">core.typed - Functions</a></li>
|
|
|
|
<li><a href="../core_typed/limitations/index.html">core.typed - Limitations</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer>Copyright © 2021 Multiple Authors
|
|
<p style="text-align: center;">Powered by <a href="http://cryogenweb.org">Cryogen</a></p></footer>
|
|
</div>
|
|
<script src="https://code.jquery.com/jquery-1.11.0.min.js"></script>
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.0/js/bootstrap.min.js"></script>
|
|
<script src="../../../js/highlight.pack.js" type="application/javascript"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
|
|
|
|
</body>
|
|
</html>
|