diff --git a/README.md b/README.md index 7c86181..336713c 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,7 @@ ![Python Wheel](https://img.shields.io/pypi/wheel/amqtt?style=flat-square) [![PyPI](https://img.shields.io/pypi/v/amqtt?style=flat-square)](https://pypi.org/project/amqtt/) -# WORK IN PROGRESS -[!!! MAINTAINERS WANTED !!!](https://github.com/Yakifo/amqtt/issues/163) +![docs/assets/amqtt.svg](docs/assets/amqtt.svg) # aMQTT @@ -53,3 +52,7 @@ $ pip install amqtt Documentation is available on [Read the Docs](http://amqtt.readthedocs.org/). Bug reports, patches and suggestions welcome! Just [open an issue](https://github.com/Yakifo/amqtt/issues/new) or join the [gitter community](https://gitter.im/amqtt/community). + + + + diff --git a/docs/assets/amqtt.svg b/docs/assets/amqtt.svg new file mode 100644 index 0000000..1306950 --- /dev/null +++ b/docs/assets/amqtt.svg @@ -0,0 +1,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/assets/amqtt_bw.svg b/docs/assets/amqtt_bw.svg new file mode 100644 index 0000000..c69ecf7 --- /dev/null +++ b/docs/assets/amqtt_bw.svg @@ -0,0 +1,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/assets/extra.css b/docs/assets/extra.css new file mode 100644 index 0000000..f044056 --- /dev/null +++ b/docs/assets/extra.css @@ -0,0 +1,17 @@ + +/* + https://coolors.co/568e83-f5fbef-84c318-9684a1-161925 + https://coolors.co/2ec0f9-67aaf9-9bbdf9-c4e0f9-b95f89 + https://coolors.co/ddd8c4-a3c9a8-84b59f-69a297-50808e +https://coolors.co/e6c229-f17105-d11149-6610f2-1a8fe3 + + + */ + +.md-header { + background: #D11149 +} + +nav.md-tabs { + display: none; +} \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index ee42133..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,22 +0,0 @@ -import os -import sys -import datetime - -sys.path.insert(0, os.path.abspath("..")) - -project = "aMQTT" -author = "Your Name" -copyright = f"{datetime.date.today().year}, {author}" - -extensions = [ - "myst_parser", - "sphinx.ext.autodoc", - "sphinx.ext.napoleon", - "sphinx_autodoc_typehints", -] - -templates_path = ["_templates"] -exclude_patterns = [] - -html_theme = "furo" -html_static_path = ["_static"] diff --git a/docs/docs/assets/amqtt.svg b/docs/docs/assets/amqtt.svg new file mode 100644 index 0000000..1306950 --- /dev/null +++ b/docs/docs/assets/amqtt.svg @@ -0,0 +1,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/index.md b/docs/index.md index 000ea34..612c7a5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1 @@ -# Welcome to MkDocs - -For full documentation visit [mkdocs.org](https://www.mkdocs.org). - -## Commands - -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. - -## Project layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +--8<-- "README.md" diff --git a/mkdocs.yml b/mkdocs.yml index 2197d9b..e9a0632 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: aMQTT +site_name: "" site_description: "Automatic documentation from sources, for MkDocs." site_url: http://github.com repo_url: http://github.com/abc/amqtt @@ -56,7 +56,7 @@ nav: theme: name: material - logo: logo.svg + logo: assets/amqtt_bw.svg features: - announce.dismiss - content.action.edit @@ -75,26 +75,21 @@ theme: - search.suggest - toc.follow palette: - - media: "(prefers-color-scheme)" - toggle: - icon: material/brightness-auto - name: Switch to light mode - - media: "(prefers-color-scheme: light)" - scheme: default - primary: teal - accent: purple - toggle: - icon: material/weather-sunny - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: black - accent: lime - toggle: - icon: material/weather-night - name: Switch to system preference -#extra_css: + # Palette toggle for light mode + - scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to light mode + +extra_css: + - assets/extra.css #- css/style.css #- css/material.css #- css/mkdocstrings.css @@ -117,7 +112,7 @@ markdown_extensions: pygments_lang_class: true - pymdownx.magiclink - pymdownx.snippets: - base_path: [!relative $config_dir] + base_path: !relative $config_dir check_paths: true - pymdownx.superfences - pymdownx.tabbed: