Add build documentation for this project
[cacert-codedocs.git] / source / index.rst
1 .. CAcert code documentation master file, created by
2 sphinx-quickstart on Fri Oct 26 23:40:43 2018.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
6 CAcert code documentation
7 =========================
8
9 This is a work in progress documentation of the CAcert web application source
10 code at https://git.cacert.org/gitweb/?p=cacert.git.
11
12 The goal is to document the existing code base to give insight into its
13 functionality and to support writing a specification for a potential
14 reimplementation.
15
16 .. toctree::
17 :maxdepth: 2
18 :caption: Contents:
19
20 building
21
22 Filesystem structure
23 --------------------
24
25 The file system structure as of 2018-10-27 looks like shown below:
26
27 .. literalinclude:: structure.txt
28 :language: text
29 :encoding: utf-8
30
31
32
33 Indices and tables
34 ==================
35
36 * :ref:`genindex`
37 * :ref:`modindex`
38 * :ref:`search`