Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mkdocs for the documentation #49

Merged
merged 9 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,4 @@ build
.coverage
_build
_autosummary
site
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ repos:
hooks:
- id: mdformat
args: ["--wrap", "79"]
exclude: ^doc/
exclude: ^docs/
additional_dependencies:
- mdformat-gfm
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
20 changes: 0 additions & 20 deletions doc/Makefile

This file was deleted.

33 changes: 0 additions & 33 deletions doc/_static/css/custom.css

This file was deleted.

Binary file removed doc/_static/logo-dark-mode.png
Binary file not shown.
Binary file removed doc/_static/logo-light-mode.png
Binary file not shown.
128 changes: 0 additions & 128 deletions doc/conf.py

This file was deleted.

7 changes: 0 additions & 7 deletions doc/content/encodings/index.md

This file was deleted.

32 changes: 0 additions & 32 deletions doc/content/encodings/instance.md

This file was deleted.

41 changes: 0 additions & 41 deletions doc/content/installation.md

This file was deleted.

11 changes: 0 additions & 11 deletions doc/content/quickstart.md

This file was deleted.

9 changes: 0 additions & 9 deletions doc/index.md

This file was deleted.

30 changes: 30 additions & 0 deletions docs/_custom/css/extra.css
Original file line number Diff line number Diff line change
@@ -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;
}
49 changes: 49 additions & 0 deletions docs/_custom/css/mkdoclingo.css
Original file line number Diff line number Diff line change
@@ -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);
}
Loading
Loading