devel-proj-hierarchy.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Mon, 22 Feb 2016 12:46:36 +0200
changeset 1905 fba288d59662
parent 1457 3a90e314bb47
child 1912 8b81a8f0f692
permissions -rw-r--r--
Include only local subsections into TOC. This prevent duplication of TOC when build single page HTML document. Also this make unnecessary CSS hack to hide document title as top level section.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1456
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     1
.. -*- coding: utf-8; -*-
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
.. include:: HEADER.rst
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     3
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     4
=============================
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     5
 Software project hierarchy.
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     6
=============================
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     7
.. contents::
1905
fba288d59662 Include only local subsections into TOC. This prevent duplication of
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1457
diff changeset
     8
   :local:
1456
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     9
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    10
Additional reading.
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    11
===================
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    12
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    13
 * http://stackoverflow.com/questions/14747056/common-practice-to-name-project-directory-which-hold-support-scripts-configs-d
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    14
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    15
Essential project dirs.
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    16
=======================
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    17
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    18
TODO
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    19
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    20
Support directories.
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    21
====================
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    22
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    23
``examples`` or ``samples`` used to show practical usage of project in
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    24
mini-scripts or mini-programs, or mini-configs.
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    25
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    26
``scripts``, ``support`` - wrappers or copy of missing scripts/utilities to
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    27
provide cross-environment build.
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    28
1457
3a90e314bb47 'contrib' dir.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1456
diff changeset
    29
``tools`` - extra utilities to profile or debug project.
3a90e314bb47 'contrib' dir.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1456
diff changeset
    30
3a90e314bb47 'contrib' dir.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1456
diff changeset
    31
``contrib`` - user supplied scripts, configs, etc...
1456
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    32
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    33
``misc``, ``etc`` - uncategorised files (if you don't know the right place for
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    34
it).
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    35
1457
3a90e314bb47 'contrib' dir.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1456
diff changeset
    36
``config``, ``extra``
1456
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    37