Merge pull request #49 from potassco/mkdocs

Mkdocs for the documentation

.gitignore

@@ -34,3 +34,4 @@ build
 .coverage
 _build
 _autosummary
+site

.pre-commit-config.yaml

@@ -30,6 +30,6 @@ repos:
     hooks:
     - id: mdformat
       args: ["--wrap", "79"]
-      exclude: ^doc/
+      exclude: ^docs/
       additional_dependencies:
       - mdformat-gfm

README.md

@@ -28,7 +28,7 @@ fillname -h
 To generate and open the documentation, run
 
 ```bash
-nox -s doc -- open
+nox -s doc -- serve
 ```
 
 Instructions to install and use `nox` can be found in

docs/_custom/css/extra.css

@@ -0,0 +1,30 @@
+:root {
+    --md-primary-fg-color: #6495ED;
+}
+
+[data-md-color-scheme="slate"] .md-header,
+[data-md-color-scheme="slate"] .md-tabs {
+    --md-primary-fg-color: #253758;
+}
+
+.md-grid {
+    max-width: 1350px;
+}
+
+.md-header__title {
+    font-size: 1.2rem;
+    height: 2.5rem;
+    line-height: 2.5rem;
+    margin-left: 0 !important;
+}
+
+.md-header__button.md-logo {
+    /* margin-left: 30; */
+    padding-bottom: 0.8rem;
+}
+
+.md-header__button.md-logo img,
+.md-header__button.md-logo svg {
+    height: 1.5rem;
+    width: 1.5rem;
+}

docs/_custom/css/mkdoclingo.css

@@ -0,0 +1,49 @@
+code.doc-clingo-symbol-encoding::after {
+    content: "ASP";
+    color: var(--md-primary-fg-color);
+}
+
+
+code.doc-clingo-symbol-predicate::after {
+    content: "predicate";
+    color: #ca91bf
+}
+
+
+:root {
+    --md-admonition-icon--asp-doc: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13.59 7.41 9 12l4.59 4.6L15 15.18 11.82 12 15 8.82M19 3a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2z"/></svg>');
+    --md-admonition-icon--asp-doc-ref: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15 7h5.5L15 1.5zM8 0h8l6 6v12a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2V2a2 2 0 0 1 2-2M4 4v18h16v2H4a2 2 0 0 1-2-2V4z"/></svg>')
+}
+
+.md-typeset .admonition.asp-doc,
+.md-typeset details.asp-doc {
+    border-color: var(--md-primary-fg-color);
+}
+
+.md-typeset .admonition.asp-doc-ref,
+.md-typeset details.asp-doc-ref {
+    border-color: #ca91bf;
+}
+
+.md-typeset .asp-doc>.admonition-title,
+.md-typeset .asp-doc>summary {
+    background-color: #1669B810;
+}
+
+.md-typeset .asp-doc-ref>.admonition-title,
+.md-typeset .asp-doc-ref>summary {
+    background-color: #ca91bf10;
+}
+
+.md-typeset .asp-doc>.admonition-title::before,
+.md-typeset .asp-doc>summary::before {
+    background-color: var(--md-primary-fg-color);
+    -webkit-mask-image: var(--md-admonition-icon--asp-doc);
+    mask-image: var(--md-admonition-icon--asp-doc);
+}
+
+.md-typeset .asp-doc-ref>summary::before {
+    background-color: #ca91bf;
+    -webkit-mask-image: var(--md-admonition-icon--asp-doc-ref);
+    mask-image: var(--md-admonition-icon--asp-doc-ref);
+}