Bug-1443; first part of implementing complete directory
[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 in the `release` branch of the :cacertgit:`cacert-devel`.
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 The code repository is mirrored to the :github:`cacert-devel` to encourage
17 contribution. The canonical repository is the :cacertgit:`cacert-devel` though.
18
19 .. toctree::
20 :maxdepth: 2
21 :caption: Contents:
22
23 general
24 directories
25 database
26 signer
27 building
28 glossary
29
30 Filesystem structure
31 --------------------
32
33 The file system structure as of 2018-10-27 looks like shown below:
34
35 .. literalinclude:: structure.txt
36 :language: text
37 :encoding: utf-8
38
39
40
41 Indices and tables
42 ==================
43
44 * :ref:`genindex`
45 * :ref:`search`