diff options
| author | Théo de la Hogue | 2023-06-06 09:26:25 +0200 |
|---|---|---|
| committer | Théo de la Hogue | 2023-06-06 09:26:25 +0200 |
| commit | 70eb07fd034a000b7821b62bdd5259716e7f1d88 (patch) | |
| tree | dd307628f00dd6bb2ee5e5f425e7bf81ad6fdd73 | |
| parent | 9ee4f593beb3df640a6b1befe453b2e5d1f97df2 (diff) | |
| download | argaze-70eb07fd034a000b7821b62bdd5259716e7f1d88.zip argaze-70eb07fd034a000b7821b62bdd5259716e7f1d88.tar.gz argaze-70eb07fd034a000b7821b62bdd5259716e7f1d88.tar.bz2 argaze-70eb07fd034a000b7821b62bdd5259716e7f1d88.tar.xz | |
Adding a Code reference section in nav bar. Adding extra css.
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | docs/api_reference.md | 4 | ||||
| -rw-r--r-- | docs/argaze.md | 4 | ||||
| -rw-r--r-- | docs/css/extra.css | 1 | ||||
| -rw-r--r-- | docs/css/mkdocstrings.css | 11 | ||||
| -rw-r--r-- | mkdocs.yml | 12 |
6 files changed, 15 insertions, 19 deletions
@@ -10,4 +10,4 @@ ArGaze can be combined with any wearable eye tracking device python library like Check out the [installation](getting_started#installation) section to start. -Check out the [API reference](api_reference) section to get deeper into library architecture. +Check out the [Code reference](argaze) section to get deeper into library architecture. diff --git a/docs/api_reference.md b/docs/api_reference.md deleted file mode 100644 index 5b69d1c..0000000 --- a/docs/api_reference.md +++ /dev/null @@ -1,4 +0,0 @@ -API Reference -=============== - -::: argaze
\ No newline at end of file diff --git a/docs/argaze.md b/docs/argaze.md new file mode 100644 index 0000000..6d2c62a --- /dev/null +++ b/docs/argaze.md @@ -0,0 +1,4 @@ +Code reference +=============== + +::: argaze
\ No newline at end of file diff --git a/docs/css/extra.css b/docs/css/extra.css new file mode 100644 index 0000000..0639582 --- /dev/null +++ b/docs/css/extra.css @@ -0,0 +1 @@ +.rst-content code {color: #404040;} diff --git a/docs/css/mkdocstrings.css b/docs/css/mkdocstrings.css deleted file mode 100644 index c213aed..0000000 --- a/docs/css/mkdocstrings.css +++ /dev/null @@ -1,11 +0,0 @@ -[data-md-color-scheme="slate"] { - --doc-symbol-attribute-fg-color: #963fb8; - --doc-symbol-function-fg-color: #6d67e4; - --doc-symbol-class-fg-color: #46c2cb; - --doc-symbol-module-fg-color: #f2f7a1; - - --doc-symbol-attribute-bg-color: #963fb81a; - --doc-symbol-function-bg-color: #6d67e41a; - --doc-symbol-class-bg-color: #46c2cb1a; - --doc-symbol-module-bg-color: #f2f7a11a; -}
\ No newline at end of file @@ -1,7 +1,13 @@ site_name: ArGaze documentation +nav: +- index.md +- getting_started.md +- Code Reference: + - argaze.md theme: name: readthedocs - highlightjs: true +extra_css: + - css/extra.css plugins: - search - mkdocstrings: @@ -17,8 +23,8 @@ plugins: annotations_path: brief show_submodules: true show_root_toc_entry: false - watch: - - src/argaze +watch: + - src/argaze markdown_extensions: - markdown_include.include: base_path: . |