https://github.com/artefactual-labs/c4

Exploring the capabilities of the C4 model with C4, Sphinx, PlantUML and ReadTheDocs.
https://github.com/artefactual-labs/c4

archivematica artefactual c4-model readthedocs sphinx sphinx-extension uml-diagrams

Last synced: about 2 months ago
JSON representation

Exploring the capabilities of the C4 model with C4, Sphinx, PlantUML and ReadTheDocs.

• Host: GitHub
• URL: https://github.com/artefactual-labs/c4
• Owner: artefactual-labs
• License: apache-2.0
• Created: 2023-10-31T12:00:50.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-13T13:29:54.000Z (about 1 year ago)
• Last Synced: 2024-03-26T10:20:03.126Z (9 months ago)
• Topics: archivematica, artefactual, c4-model, readthedocs, sphinx, sphinx-extension, uml-diagrams
• Language: Python
• Homepage: https://c4test.rtfd.io
• Size: 10.3 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# C4 Model Diagrams Repository

Welcome to our repository, where we explore the capabilities of the C4 model

through a series of diagrams created for testing and demonstration purposes.

Visit the site: https://c4test.rtfd.io/.

## Components

- C4 Model: graphical notation technique for modelling the arquitecture of

  software systems.

- Sphinx: documentation generator.

- PlantUML for Sphinx: integration with PlantUML.

- ReadTheDocs: hosting and real-time building of our documentation.

## License

This repository and its contents are licensed under the Apache License, Version

2.0. It contains a version of PlantUML, which is licensed under the GNU General

Public License version 2 (GPLv2). The PlantUML JAR is located under the

`vendor` directory of this repository.

## TODO

- Try https://github.com/sphinx-contrib/kroki.