search

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

Create documentation with MkDocs #57

Closed Midnighter closed 3 years ago

Midnighter commented 3 years ago

I've configured and added some initial documentation with MkDocs. I still need to work on the integration with readthedocs so that we can actually host it online. You can try it out locally. I'm quite fond of it.

codecov-io commented 3 years ago

Codecov Report

Merging #57 (e5aeae6) into devel (45941c9) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##            devel      #57   +/-   ##
=======================================
  Coverage   89.54%   89.54%           
=======================================
  Files          67       67           
  Lines        1933     1933           
  Branches      169      169           
=======================================
  Hits         1731     1731           
  Misses        177      177           
  Partials       25       25

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 45941c9...e5aeae6. Read the comment docs.

Midnighter commented 3 years ago

Was there anything else that you wanted to document right away @mrchrisadams ?

Midnighter commented 3 years ago

I think, these docs are an improvement so I will merge them now. Can always add more later.