Documentor Documentation 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# -*- coding: utf-8 -*-
#
# This file is part of Documentor
# (https://github.com/diegosarmentero/documentor).
#
# Documentor is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# any later version.
#
# Documentor is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Documentor; If not, see <http://www.gnu.org/licenses/>.

"""Templates to generate the restructured text results."""

BASE_FILE = """.. link:
.. description:
.. tags:
.. date: %(date)s
.. title: %(projectname)s
.. slug: %(filename)s

.. class:: alert alert-info pull-top

.. contents::

"""

MODULE = "\n*Module:* `%(name)s <%(link)s>`_ API\n"  # ==
IMPORTS = "\n*Imports:*\n"  # --
GLOBAL_ATTRIBUTES = "\n*Global Attributes:*\n"  # --
GLOBAL_FUNCTIONS = "\n*Global Functions:*\n"  # --
CLASS = "\n*Class:* `%(name)s <%(link)s>`_\n"  # --
CODE = """\n.. code:: python

       %(code)s

"""
PARENTS = "\n*Parents*\n"  # ~~
ATTRIBUTES = "\n*Attributes*\n"  # ~~
FUNCTION = "\n*Function:* `%(name)s <%(link)s>`_\n"  # ~~
NO_DESCRIPTION = "\nNo description.\n\n"
ARGUMENTS = "\n**Arguments:**\n"
DECORATORS = "\n**Decorators:**\n\n"
LIST_LINK_ITEM = '- `%(name)s <%(link)s>`_\n'

###############################################################################

POST = """
.. link:
.. description:
.. tags:
.. date: %(date)s
.. title: %(projectname)s
.. slug: documentor

`Modules </documentor_modules.html>`_
=========================================
Check out the Modules of the project

----

`Classes </documentor_classes.html>`_
=========================================
Check out the Classes of the project

----

`Functions </documentor_functions.html>`_
=============================================
Check out the functions of the project

"""

HTML_FILES_HEADER = """
<!DOCTYPE html><html lang="en">
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <meta charset="utf-8">
    <meta name="description" content="">
    <meta name="author" content="%(projectname)s">
    <title>%(projectname)s | %(projectname)s Documentation</title>
            <link href="assets/css/bootstrap.min.css" rel="stylesheet" type="text/css">
            <link href="assets/css/bootstrap-responsive.min.css" rel="stylesheet" type="text/css">
        <link href="assets/css/rst.css" rel="stylesheet" type="text/css">
        <link href="assets/css/code.css" rel="stylesheet" type="text/css">
        <link href="assets/css/colorbox.css" rel="stylesheet" type="text/css">
        <link href="assets/css/theme.css" rel="stylesheet" type="text/css">
        <link rel="alternate" type="application/rss+xml" title="RSS" href="../../rss.xml">
</head>
<body>
<!-- Menubar -->
<div class="navbar navbar-fixed-top">
    <div class="navbar-inner">
        <div class="container">
        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
        <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
        </a>
            <a class="brand" href="#">
            %(projectname)s Documentation
            </a>
            <!-- Everything you want hidden at 940px or less, place within here -->
            <div class="nav-collapse collapse">
                <ul class="nav">
            <li><a href="documentor_modules.html">Modules</a>
            </li><li><a href="documentor_classes.html">Classes</a>
            </li><li><a href="documentor_functions.html">Functions</a>
                </li></ul>
            </div>
        </div>
    </div>
</div>
<!-- End of Menubar -->
<div class="container-fluid" id="container-fluid">
    <!--Body content-->
    <div class="row-fluid">
    <div class="span2"></div>
    <div class="span8">

    <h1>%(projectname)s</h1>
    <div class="contents alert alert-info pull-top topic" id="contents">
<p class="topic-title first">Index</p>
<ul class="simple">
<li><a class="reference internal" href="documentor_modules.html" id="id1"><em>Modules</em></a>
<li><a class="reference internal" href="documentor_classes.html" id="id1"><em>Classes</em></a>
<li><a class="reference internal" href="documentor_functions.html" id="id1"><em>Functions</em></a>
</li>
</ul>
</div>
<div class="section" id="classes">
<h2><em>%(type)s:</em></h2>
<div class="section" id="classes">
<ul class="simple">
"""

HTML_FILES_BODY = """
<li><a class="reference external" href="%(link)s">%(name)s</a></li>"""

HTML_FILES_FOOTER = """
</ul>
</div>
<div class="footerbox">
    Contents © %(year)s         <a href="#">%(projectname)s</a> - Powered by         <a href="http://nikola.ralsina.com.ar">Nikola</a> and <a href="https://github.com/diegosarmentero/documentor">Documentor</a>
</div>
            <script src="assets/js/jquery-1.7.2.min.js" type="text/javascript"></script>
            <script src="assets/js/bootstrap.min.js" type="text/javascript"></script>
        <script src="assets/js/jquery.colorbox-min.js" type="text/javascript"></script>
    <script type="text/javascript">jQuery("a.image-reference").colorbox({rel:"gal",maxWidth:"80%%",maxHeight:"80%%",scalePhotos:true});</script>
</body>
</html>
"""
Contents © 2013 Documentor - Powered by Nikola and Documentor