Midnighter / structurizr-python

A Python 3 port of Simon Brown's Structurizr diagrams-as-code architecture description tool.
https://structurizr.com/
Apache License 2.0
65 stars 16 forks source link

Add sample code to readme to get started from existing project fix #44 #45

Closed mrchrisadams closed 3 years ago

mrchrisadams commented 3 years ago

This PR adds further docs for taking an existing project, and downloading it, so you can add it to source control, or similar.

codecov-io commented 3 years ago

Codecov Report

Merging #45 into devel will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##            devel      #45   +/-   ##
=======================================
  Coverage   85.10%   85.10%           
=======================================
  Files          64       64           
  Lines        1745     1745           
  Branches      151      151           
=======================================
  Hits         1485     1485           
  Misses        228      228           
  Partials       32       32           

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update a8c6958...f03b2bc. Read the comment docs.

Midnighter commented 3 years ago

I should add that @ilaif and I had been talking about using MkDocs instead of Sphinx for documentation. That would mean converting all restructured text documents, like README.rst to markdown.

In addition, I wanted to add mkdocstrings such that docstrings are automatically converted to reference documentation. (We already use Google-style docstrings in this project.)

Midnighter commented 3 years ago

The markdown documentation was mentioned in #15. Let's see if I can create a good starting point for that.

Midnighter commented 3 years ago

I have added docs in #57 and the docs are now online at https://structurizr-python.readthedocs.io/en/latest/ :tada: I'm closing this now but please don't be shy to add more documentation :wink: