diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
index c2682af..bdec867 100644
--- a/.github/workflows/doc.yml
+++ b/.github/workflows/doc.yml
@@ -22,10 +22,10 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v6
- - name: Set up Python 3.11
+ - name: Set up Python 3.12
uses: actions/setup-python@v6
with:
- python-version: 3.11
+ python-version: 3.12
- name: Install dependencies
run: |
python -m pip install --upgrade pip
@@ -43,7 +43,7 @@ jobs:
runs-on: ubuntu-latest
environment:
name: github-pages
- url: ${{steps.deployment.outputs.page_url}}
+ url: ${{ format('{0}docs/', steps.deployment.outputs.page_url) }}
needs: build
steps:
- name: Deploy to GitHub Pages
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4a92bbc..487befb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
# Contributing
-Thanks for considering a contribution to fillname. ❤️
+Thanks for considering a contribution to fillname.
## How to get help or discuss possible contributions
@@ -16,7 +16,7 @@ To avoid duplicating issues, please search our [issue tracker][issues] and our
changes.
- Submit a pull request to the master branch with your changes.
- Respond to feedback on your pull request.
-- If everything is fine your pull request is merged. 🥳
+- If everything is fine your pull request is merged!
## License
diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md
index bec251c..7a00937 100644
--- a/DEPLOYMENT.md
+++ b/DEPLOYMENT.md
@@ -18,8 +18,9 @@ new tag. To enable this:
- Navigate to **Settings** > **Pages**.
- Under **Build and deployment**, set **Source** to **GitHub Actions**.
-This setup ensures your documentation is updated and available online whenever
-you create a new release tag via Github workflows.
+This setup ensures your documentation is updated whenever you create a new
+release tag via GitHub workflows. The final documentation will be made
+available at `https://potassco.org/fillname/docs`.
[environment]: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment/
[guide]: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 40addce..6dbffe8 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -1,5 +1,11 @@
# Development
+To install the project in development mode, use the following command:
+
+```bash
+pip install -e .[dev]
+```
+
To improve code quality, we use [nox] to run linters, type checkers, unit
tests, and more. We recommend installing nox using [pipx] to have it available
globally.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
new file mode 100644
index 0000000..25d3fe0
--- /dev/null
+++ b/docs/SUMMARY.md
@@ -0,0 +1,16 @@
+* Getting Started
+ * [Quick Start Guide](use/quick-start.md)
+ * [Installation](use/installation.md)
+ * [Help](use/help.md)
+* Reference
+ * [Reference](reference/index.md)
+ * [Encodings](reference/encodings/index.md)
+ * [API](reference/api/index.md)
+ * [CLI](reference/cli/index.md)
+* Examples
+ * [Examples](examples/index.md)
+* Community
+ * [Contributing](community/CONTRIBUTING.md)
+ * [Changes](community/CHANGES.md)
+ * [Development](community/DEVELOPMENT.md)
+ * [Deployment](community/DEPLOYMENT.md)
diff --git a/docs/_custom/css/extra.css b/docs/_custom/css/extra.css
index 833d4ea..5b6ceac 100644
--- a/docs/_custom/css/extra.css
+++ b/docs/_custom/css/extra.css
@@ -1,9 +1,29 @@
-[data-md-color-scheme="default"] {
- --md-primary-fg-color: #4378dc;
- --md-primary-fg-color--light: #4378dc;
- --md-primary-fg-color--dark: #4378dc;
+/* ============================================================
+ Brand colors
+ ============================================================ */
+
+:root {
+ --md-primary-fg-color: #6495ED;
+}
+
+[data-md-color-scheme="default"] .md-header,
+[data-md-color-scheme="default"] .md-tabs,
+[data-md-color-scheme="slate"] .md-header,
+[data-md-color-scheme="slate"] .md-tabs {
+ --md-primary-fg-color: #2E3360;
+}
+
+[data-md-color-scheme="default"] .md-nav--primary .md-nav__title,
+[data-md-color-scheme="slate"] .md-nav--primary .md-nav__title {
+ background-color: #2E3360;
+}
+
+
+/* ============================================================
+ Code highlight colors
+ ============================================================ */
- /* Code colors – light background */
+[data-md-color-scheme="default"] {
--md-code-hl-number-color: hsl(11, 80%, 40%);
--md-code-hl-special-color: hsl(340, 75%, 45%);
--md-code-hl-function-color: hsl(271, 55%, 45%);
@@ -19,11 +39,6 @@
}
[data-md-color-scheme="slate"] {
- --md-typeset-a-color: #4378dc;
- --md-primary-fg-color: #253758;
- --md-primary-fg-color--dark: #253758;
-
- /* Code colors – dark background */
--md-code-hl-number-color: hsl(11, 85%, 68%);
--md-code-hl-special-color: hsl(340, 82%, 72%);
--md-code-hl-function-color: hsl(271, 70%, 78%);
@@ -39,10 +54,19 @@
}
+/* ============================================================
+ Layout
+ ============================================================ */
+
.md-grid {
max-width: 1350px;
}
+
+/* ============================================================
+ Header
+ ============================================================ */
+
.md-header__title {
font-size: 1.2rem;
height: 2.5rem;
@@ -51,7 +75,6 @@
}
.md-header__button.md-logo {
- /* margin-left: 30; */
padding-bottom: 0.8rem;
}
@@ -60,3 +83,83 @@
height: 1.5rem;
width: 1.5rem;
}
+
+
+/* ============================================================
+ Admonitions
+ ============================================================ */
+
+.md-typeset .admonition,
+.md-typeset details {
+ border-width: 0;
+ border-left-width: 3px;
+}
+
+/* info / note / abstract / tip — primary color */
+.md-typeset .info>.admonition-title,
+.md-typeset .info>summary,
+.md-typeset .note>.admonition-title,
+.md-typeset .note>summary,
+.md-typeset .abstract>.admonition-title,
+.md-typeset .abstract>summary,
+.md-typeset .tip>.admonition-title,
+.md-typeset .tip>summary {
+ border-color: var(--md-primary-fg-color);
+ background-color: color-mix(in srgb, var(--md-primary-fg-color) 10%, transparent);
+}
+
+.md-typeset .admonition.info,
+.md-typeset details.info,
+.md-typeset .admonition.note,
+.md-typeset details.note,
+.md-typeset .admonition.abstract,
+.md-typeset details.abstract,
+.md-typeset .admonition.tip,
+.md-typeset details.tip {
+ border-color: var(--md-primary-fg-color);
+}
+
+.md-typeset .info>.admonition-title::before,
+.md-typeset .info>summary::before,
+.md-typeset .note>.admonition-title::before,
+.md-typeset .note>summary::before,
+.md-typeset .abstract>.admonition-title::before,
+.md-typeset .abstract>summary::before,
+.md-typeset .tip>.admonition-title::before,
+.md-typeset .tip>summary::before {
+ background-color: var(--md-primary-fg-color);
+}
+
+/* question — yellow */
+.md-typeset .question>.admonition-title,
+.md-typeset .question>summary {
+ border-color: #A8AD00;
+ background-color: color-mix(in srgb, #A8AD00 10%, transparent);
+}
+
+.md-typeset .admonition.question,
+.md-typeset details.question {
+ border-color: #A8AD00;
+}
+
+.md-typeset .question>.admonition-title::before,
+.md-typeset .question>summary::before {
+ background-color: #A8AD00;
+}
+
+/* success — green */
+.md-typeset .success>.admonition-title,
+.md-typeset .success>summary {
+ border-color: #2E7D32;
+ background-color: color-mix(in srgb, #2E7D32 10%, transparent);
+}
+
+.md-typeset .admonition.success,
+.md-typeset details.success {
+ border-color: #2E7D32;
+}
+
+.md-typeset .success>.admonition-title::before,
+.md-typeset .success>summary::before {
+ background-color: #2E7D32;
+}
diff --git a/docs/_custom/overrides/.icons/potassco-full-logo.svg b/docs/_custom/overrides/.icons/potassco-full-logo.svg
deleted file mode 100644
index b5c199c..0000000
--- a/docs/_custom/overrides/.icons/potassco-full-logo.svg
+++ /dev/null
@@ -1,3 +0,0 @@
-
diff --git a/docs/_custom/overrides/.icons/potassco-logo.svg b/docs/_custom/overrides/.icons/potassco-logo.svg
index fde2a4a..cf24ead 100644
--- a/docs/_custom/overrides/.icons/potassco-logo.svg
+++ b/docs/_custom/overrides/.icons/potassco-logo.svg
@@ -1,3 +1,12 @@
-