diff --git a/docs/.pages b/docs/.pages index f82e865..697cb6a 100644 --- a/docs/.pages +++ b/docs/.pages @@ -1,5 +1,5 @@ nav: - - index.md - - reference.md - - "Example notebook": examples/client_example.ipynb - - changelog.md + - "Summary": index.md + - "API Reference": reference.md + - "Example notebook": examples/client_example + - "Changelog": changelog.md diff --git a/docs/css/reference.css b/docs/css/reference.css new file mode 100644 index 0000000..b10ab72 --- /dev/null +++ b/docs/css/reference.css @@ -0,0 +1,32 @@ +div.doc-contents:not(.first) { + padding-left: 25px; + border-left: 4px solid rgba(230, 230, 230, 0.5); + margin-bottom: 80px; +} + +.jupyter-wrapper { + --jp-code-font-family-default: 'Iosevka Web', monospace; +} + +pre { + font-family: 'Iosevka Web', monospace; +} + +td code { + word-break: normal !important; +} + +code { + max-height: 20em; +} + +.md-grid { + max-width: 70rem; +} + +:root { + --md-text-font: "Figtree", sans-serif; + --md-code-font: "Iosevka Web", monospace; + --jp-code-font-family-default: 'Iosevka Web', monospace; + --jp-code-font-family: 'Iosevka Web', monospace; +} diff --git a/docs/overrides/main.html b/docs/overrides/main.html new file mode 100644 index 0000000..5e7f461 --- /dev/null +++ b/docs/overrides/main.html @@ -0,0 +1,21 @@ +{% extends "base.html" %} + +{% block extrahead %} + + + +{% endblock %} diff --git a/mkdocs.yml b/mkdocs.yml index 5f0a52a..9bde0ee 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ -site_name: datalab-api -site_description: Documentation for the datalab Python API +site_name: datalab Python API +site_description: Documentation for the *datalab* Python API site_url: https://datalab-api.readthedocs.io theme: @@ -25,10 +25,10 @@ theme: name: Switch to light mode primary: amber accent: brown + custom_dir: docs/overrides font: text: Figtree - code: Iosevka Web features: - content.code.copy @@ -40,7 +40,7 @@ docs_dir: "./docs" extra: social: - icon: fontawesome/brands/github - link: https://github.com/the-grey-group + link: https://github.com/datalab-org markdown_extensions: - admonition @@ -99,6 +99,9 @@ plugins: execute: false allow_errors: false include_requirejs: true + include_source: true + #- privacy: + # enabled: true watch: - src