2018-10-26 23:21:25 +00:00
|
|
|
.. CAcert code documentation master file, created by
|
2018-10-26 21:40:56 +00:00
|
|
|
sphinx-quickstart on Fri Oct 26 23:40:43 2018.
|
|
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
|
2018-10-27 12:26:40 +00:00
|
|
|
CAcert code documentation
|
|
|
|
|
=========================
|
2018-10-26 21:40:56 +00:00
|
|
|
|
2018-10-26 21:53:43 +00:00
|
|
|
This is a work in progress documentation of the CAcert web application source
|
2018-10-28 09:14:12 +00:00
|
|
|
code in the `release` branch of the :cacertgit:`cacert-devel`.
|
2018-10-26 21:53:43 +00:00
|
|
|
|
|
|
|
|
The goal is to document the existing code base to give insight into its
|
|
|
|
|
functionality and to support writing a specification for a potential
|
|
|
|
|
reimplementation.
|
|
|
|
|
|
2018-10-28 09:14:12 +00:00
|
|
|
The code repository is mirrored to the :github:`cacert-devel` to encourage
|
|
|
|
|
contribution. The canonical repository is the :cacertgit:`cacert-devel` though.
|
|
|
|
|
|
2018-10-26 21:40:56 +00:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: Contents:
|
|
|
|
|
|
2018-10-28 18:22:32 +00:00
|
|
|
general
|
2018-10-28 10:00:55 +00:00
|
|
|
directories
|
|
|
|
|
database
|
2018-10-28 18:22:32 +00:00
|
|
|
signer
|
2018-10-27 12:26:40 +00:00
|
|
|
building
|
2018-10-28 18:22:32 +00:00
|
|
|
glossary
|
2018-10-27 12:26:40 +00:00
|
|
|
|
2018-10-26 22:27:02 +00:00
|
|
|
Filesystem structure
|
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
|
|
The file system structure as of 2018-10-27 looks like shown below:
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: structure.txt
|
|
|
|
|
:language: text
|
|
|
|
|
:encoding: utf-8
|
|
|
|
|
|
2018-10-26 21:40:56 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`search`
|
