Merge pull request #36 from callowayproject/mkdocs-switch

Switch to mkDocs

.gitignore

@@ -167,4 +167,3 @@ site-packages
 reports
 docsrc/_autosummary/
 /docsrc/_build/
-/docs/

.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
       - id: check-symlinks
       - id: check-toml
       - id: check-yaml
-        exclude: test.*
+        exclude: test.*|mkdocs.yml
         args: [--allow-multiple-documents]
       - id: debug-statements
       - id: end-of-file-fixer

README.md

@@ -10,6 +10,8 @@ Use your commit log to make a beautiful changelog file.
 - [Documentation](https://callowayproject.github.io/generate-changelog/)
 - [GitHub](https://github.com/callowayproject/generate-changelog)
 
+<!--start-->
+
 `generate-changelog` does what it says: it generates a full changelog, or updates an existing one. Git tags and commits are the inputs by which `generate-changelog` performs its task.
 
 The primary goal of this tool was to provide the benefits of [conventional commits](https://www.conventionalcommits.org/) without requiring a strict syntax. `generate-changelog` accomplishes this using configurable regular expressions or commit metadata matching. The thought is natural language is easier for developers to remember and requires less tooling to enforce.
@@ -44,7 +46,7 @@ The primary goal of this tool was to provide the benefits of [conventional commi
 
 ## Requirements
 
-Python 3.7 or higher.
+Python 3.9 or higher.
 
 ## Installation
 
@@ -67,3 +69,4 @@ Generate your changelog via:
 ```bash
 $ generate-changelog
 ```
+<!--end-->

docs/assets/css/cards.css

@@ -0,0 +1,200 @@
+/*************
+ Grid Modification
+*/
+
+.md-typeset .grid.wide-gap {
+  gap: 1rem;
+}
+
+/*************
+ Cards
+*/
+.card-container {
+  background-color: white;
+  color: rgba(0, 0, 0, 0.87);
+  border-radius: 4px;
+  box-shadow: rgba(0, 0, 0, 0.2) 0 2px 1px -1px, rgba(0, 0, 0, 0.14) 0 1px 1px 0, rgba(0, 0, 0, 0.12) 0 1px 3px 0;
+  overflow: hidden;
+}
+
+.card-container.depth-0 {
+  box-shadow: none;
+}
+
+/*************
+ Cards - Header
+*/
+
+.card-header {
+  padding: 16px 16px 24px;
+  background: var(--md-primary-fg-color);
+  color: var(--md-primary-bg-color);
+}
+
+.card-header.backstage-green {
+  background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='1368' height='400' fill='none'%3e%3cmask id='a' width='1368' height='401' x='0' y='0' maskUnits='userSpaceOnUse'%3e%3cpath fill='url(%23paint0_linear)' d='M437 116C223 116 112 0 112 0h1256v400c-82 0-225-21-282-109-112-175-436-175-649-175z'/%3e%3cpath fill='url(%23paint1_linear)' d='M1368 400V282C891-29 788 40 711 161 608 324 121 372 0 361v39h1368z'/%3e%3cpath fill='url(%23paint2_linear)' d='M1368 244v156H0V94c92-24 198-46 375 0l135 41c176 51 195 109 858 109z'/%3e%3cpath fill='url(%23paint3_linear)' d='M1252 400h116c-14-7-35-14-116-16-663-14-837-128-1013-258l-85-61C98 28 46 8 0 0v400h1252z'/%3e%3c/mask%3e%3cg mask='url(%23a)'%3e%3cpath fill='white' d='M-172-98h1671v601H-172z'/%3e%3c/g%3e%3cdefs%3e%3clinearGradient id='paint0_linear' x1='602' x2='1093.5' y1='-960.5' y2='272' gradientUnits='userSpaceOnUse'%3e%3cstop stop-color='white'/%3e%3cstop offset='1' stop-color='white' stop-opacity='0'/%3e%3c/linearGradient%3e%3clinearGradient id='paint1_linear' x1='482' x2='480' y1='1058.5' y2='70.5' gradientUnits='userSpaceOnUse'%3e%3cstop stop-color='white'/%3e%3cstop offset='1' stop-color='white' stop-opacity='0'/%3e%3c/linearGradient%3e%3clinearGradient id='paint2_linear' x1='424' x2='446.1' y1='-587.5' y2='274.6' gradientUnits='userSpaceOnUse'%3e%3cstop stop-color='white'/%3e%3cstop offset='1' stop-color='white' stop-opacity='0'/%3e%3c/linearGradient%3e%3clinearGradient id='paint3_linear' x1='587' x2='349' y1='-1120.5' y2='341' gradientUnits='userSpaceOnUse'%3e%3cstop stop-color='white'/%3e%3cstop offset='1' stop-color='white' stop-opacity='0'/%3e%3c/linearGradient%3e%3c/defs%3e%3c/svg%3e"), linear-gradient(90deg, rgb(0, 91, 75), rgb(0, 91, 75));
+  color: rgb(255, 255, 255);
+}
+
+.card-header.backstage-blue {
+  background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='1368' height='400' fill='none'%3e%3cmask id='a' width='1368' height='401' x='0' y='0' maskUnits='userSpaceOnUse'%3e%3cpath fill='url(%23paint0_linear)' d='M437 116C223 116 112 0 112 0h1256v400c-82 0-225-21-282-109-112-175-436-175-649-175z'/%3e%3cpath fill='url(%23paint1_linear)' d='M1368 400V282C891-29 788 40 711 161 608 324 121 372 0 361v39h1368z'/%3e%3cpath fill='url(%23paint2_linear)' d='M1368 244v156H0V94c92-24 198-46 375 0l135 41c176 51 195 109 858 109z'/%3e%3cpath fill='url(%23paint3_linear)' d='M1252 400h116c-14-7-35-14-116-16-663-14-837-128-1013-258l-85-61C98 28 46 8 0 0v400h1252z'/%3e%3c/mask%3e%3cg mask='url(%23a)'%3e%3cpath fill='white' d='M-172-98h1671v601H-172z'/%3e%3c/g%3e%3cdefs%3e%3clinearGradient id='paint0_linear' x1='602' x2='1093.5' y1='-960.5' y2='272' gradientUnits='userSpaceOnUse'%3e%3cstop stop-color='white'/%3e%3cstop offset='1' stop-color='white' stop-opacity='0'/%3e%3c/linearGradient%3e%3clinearGradient id='paint1_linear' x1='482' x2='480' y1='1058.5' y2='70.5' gradientUnits='userSpaceOnUse'%3e%3cstop stop-color='white'/%3e%3cstop offset='1' stop-color='white' stop-opacity='0'/%3e%3c/linearGradient%3e%3clinearGradient id='paint2_linear' x1='424' x2='446.1' y1='-587.5' y2='274.6' gradientUnits='userSpaceOnUse'%3e%3cstop stop-color='white'/%3e%3cstop offset='1' stop-color='white' stop-opacity='0'/%3e%3c/linearGradient%3e%3clinearGradient id='paint3_linear' x1='587' x2='349' y1='-1120.5' y2='341' gradientUnits='userSpaceOnUse'%3e%3cstop stop-color='white'/%3e%3cstop offset='1' stop-color='white' stop-opacity='0'/%3e%3c/linearGradient%3e%3c/defs%3e%3c/svg%3e"), linear-gradient(90deg, rgb(0, 109, 143), rgb(0, 73, 161));
+  color: rgb(255, 255, 255);
+}
+
+.card-header p.subtitle {
+  margin: 0;
+  font-size: 0.8em;
+  font-family: "Helvetica Neue", Helvetica, Roboto, Arial, sans-serif;
+  font-weight: 500;
+  line-height: 1.57;
+}
+
+.card-header p.title {
+  margin: 0;
+  font-size: 1.14em;
+  font-family: "Helvetica Neue", Helvetica, Roboto, Arial, sans-serif;
+  font-weight: 700;
+  line-height: 1.6;
+  margin-bottom: 2px;
+}
+
+/*************
+ Cards - Media
+*/
+
+.card-media {
+  display: block;
+  background-size: cover;
+  background-repeat: no-repeat;
+  background-position: center;
+  width: 100%;
+  object-fit: cover;
+}
+
+.card-media p {
+  margin: 0;
+}
+
+/*************
+ Cards - Content
+*/
+
+.card-content {
+  padding: 16px;
+}
+
+.card-content p {
+  margin: 0;
+}
+
+.card-content p + p {
+  margin-top: 1em;
+}
+
+.card-content-title {
+  margin-top: 0;
+  font-weight: 400;
+  font-size: 1.5rem;
+  line-height: 1.334;
+  letter-spacing: 0;
+  margin-bottom: 0.35em;
+}
+
+.card-content-title p {
+  margin: 0;
+}
+
+/*************
+ Cards - Actions
+*/
+
+.card-actions {
+  padding: 16px;
+}
+
+.card-actions ul:not([hidden]) {
+  display: flex;
+  margin: 0;
+}
+
+.card-actions ul {
+  list-style: none;
+  padding: 0;
+  margin: 0;
+  display: flex;
+  flex-wrap: wrap;
+  gap: 16px;
+}
+.card-actions.right ul {
+  justify-content: flex-end;
+}
+
+.card-actions p {
+  margin: 0;
+}
+
+[dir=ltr] .card-actions ul li {
+  margin: 0;
+}
+
+.card-actions a {
+  background-color: transparent;
+  margin-top: 0;
+  vertical-align: middle;
+  font-weight: 500;
+  font-size: 0.8125rem;
+  line-height: 1.75;
+  letter-spacing: 0.02857em;
+  text-transform: uppercase;
+}
+
+/*************
+ Cards - Tags
+*/
+
+.card-tags {
+  display: flex;
+  flex-wrap: wrap;
+  box-sizing: border-box;
+  padding: 16px;
+}
+
+.card-tags ul:not([hidden]) {
+  display: flex;
+  margin: 0;
+}
+
+.card-tags ul {
+  list-style: none;
+  padding: 0;
+  margin: 0;
+  display: flex;
+  flex-wrap: wrap;
+  gap: 16px;
+}
+
+[dir=ltr] .card-tags ul li {
+  padding: 2px 8px;
+  margin: 0;
+  box-sizing: border-box;
+  font-size: 12px;
+  font-weight: 500;
+  color: #000;
+  background-color: rgba(0, 0, 0, 0.12);
+  border-radius: 16px;
+  height: 24px;
+  line-height: 20px;
+}
+
+/*************
+ Cards - Divider
+*/
+
+.card-divider {
+  margin: 0;
+  padding: 0 16px;
+}
+
+.card-divider hr {
+  margin: 0;
+}

docs/assets/css/extra.css

@@ -0,0 +1,54 @@
+/* Indentation. */
+div.doc-contents:not(.first) {
+  padding-left: 25px;
+  border-left: .05rem solid var(--md-typeset-table-color);
+}
+
+/* Normal size fonts on parameter tables */
+.md-typeset div.doc-contents table {
+  font-size: 1em;
+  width: 100%;
+  display: table;
+}
+
+/* Mark external links as such. */
+a.autorefs-external::after {
+  /* https://primer.style/octicons/arrow-up-right-24 */
+  background-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="rgb(0, 0, 0)" d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+  content: ' ';
+
+  display: inline-block;
+  vertical-align: middle;
+  position: relative;
+  bottom: 0.1em;
+  margin-left: 0.2em;
+  margin-right: 0.1em;
+
+  height: 0.7em;
+  width: 0.7em;
+  border-radius: 100%;
+  background-color: var(--md-typeset-a-color);
+}
+a.autorefs-external:hover::after {
+  background-color: var(--md-accent-fg-color);
+}
+span.doc-param-annotation:first-child{
+  border-top: 1px solid var(--md-typeset-table-color);
+  padding-top: 5px;
+  margin-top: 5px;
+  margin-bottom: -5px;
+}
+span.doc-param-annotation {
+  font-size: 0.8em;
+  display: block;
+}
+span.doc-param-default {
+  font-size: 0.8em;
+  float: unset;
+}
+.doc-label { border-radius: 15px; padding: 0 5px; }
+.doc-label code { background-color: transparent; color: white;}
+.doc-label-special { background-color: blue; color: white; }
+.doc-label-private { background-color: red; color: white; }
+.doc-label-property { background-color: green; color: white; }
+.doc-label-read-only { background-color: yellow; color: black; }

docs/assets/css/field-list.css

@@ -0,0 +1,34 @@
+dl.field-list .doc-param-default, dl.doc-field-list .doc-param-default {
+  float: none;
+}
+
+.field-list > dl, dl.field-list, dl.doc-field-list {
+  display: flex;
+  flex-flow: row wrap;
+  padding-left: 10px;
+}
+
+.field-list > dl > dt, dl.field-list > dt, dl.doc-field-list > dt {
+  flex-basis: 20%;
+  font-weight: bold;
+  word-break: break-word;
+  padding: 10px 0;
+  border-bottom: 1px solid #e5e5e5;
+}
+
+.field-list > dl > dt:after, dl.field-list > dt:after {
+  content: ":";
+}
+
+[dir=ltr] .field-list > dl > dd, dl.field-list > dd.doc-field-def, dl.doc-field-list > dd.doc-field-def {
+  flex-basis: 70%;
+  flex-grow: 1;
+  margin: 0;
+  padding: 10px 0 10px 10px;
+  border-bottom: 1px solid #e5e5e5;
+}
+
+dd.doc-field-def > p:last-child {
+  padding-bottom: 0;
+  margin-bottom: 0;
+}

docs/assets/css/mkdocstrings.css

@@ -0,0 +1,39 @@
+/* Indentation. */
+div.doc-contents:not(.first) {
+  padding-left: 25px;
+  border-left: .05rem solid var(--md-typeset-table-color);
+}
+
+/* Mark external links as such. */
+a.external::after,
+a.autorefs-external::after {
+  /* https://primer.style/octicons/arrow-up-right-24 */
+  mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+  -webkit-mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+  content: ' ';
+
+  display: inline-block;
+  vertical-align: middle;
+  position: relative;
+
+  height: 1em;
+  width: 1em;
+  background-color: var(--md-typeset-a-color);
+}
+
+a.external:hover::after,
+a.autorefs-external:hover::after {
+  background-color: var(--md-accent-fg-color);
+}
+
+.doc-param-key, .doc-field-term, .doc-section-head {
+  font-weight: bold;
+}
+
+.doc.doc-heading {
+  text-transform: none;
+}
+
+h5.doc-heading, h6.doc-heading {
+  font-size: 1em;
+}