This is a template to documents software architectures using arc42 in reStructuredText (rst). Furthermore, this repository contains all bits to compile the documentation using Sphinx.
- Clone this repository and replace all occurrences of
{PROJECT}
with the actual project name:find . -type f -exec sed -i 's/{PROJECT}/Concrete Project Name/g' {} +
- In source/conf.py replace
{AUTHOR}
with your name. - Also remove the
.github/
directory.
See the Development section in the README at the root of this repository.