diff --git a/docs/dev.md b/docs/dev.md index ae74a6b8..e8f0315d 100644 --- a/docs/dev.md +++ b/docs/dev.md @@ -120,13 +120,3 @@ However, if you are using an IDE, you can also run the `main.py` file directly. At the bottom of the `main.py` file, you can see that there are two actual ways to run the GUI: with `fbs` and without `fbs` installed. If you use either of the described methods to start the GUI, the `gui_start` method in the `main.py` file will be called. This method automatically detects whether `fbs` is installed or not. - -## Firmware - -The firmware is written in Arduino C++. Please see the [firmware documentation](firmware.md) for details on -installation. - -## Hardware - -If you would like to contribute hardware designs, please get in touch with us by -[raising an issue](https://github.com/bossjones/goob_ai/issues). diff --git a/docs/index.md b/docs/index.md index 8b3d75e1..cc625269 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,7 +8,6 @@ [![Docs](https://img.shields.io/badge/Docs-mkdocs-purple.svg?style=flat)](https://github.com/pages/bossjones/goob_ai) [![github](https://img.shields.io/badge/git.corp-toolbox-purple.svg?style=flat)](https://github.com/bossjones/goob_ai) [![Code style: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) -[![CircleCI](https://circle.ci.adobe.com/status-badge/img/gh/bossjones/goob_ai/tree/main.svg?style=svg)](https://circle.ci.adobe.com/status-badge/redirect/gh/bossjones/goob_ai/tree/main) ## Welcome! @@ -94,11 +93,3 @@ Here's a breakdown of each item in the `.env` file: All source code is available on [GitHub](https://github.com/bossjones/goob_ai). If you encounter any problems, would like to contribute, have feature requests, please get in contact by filing an [issue on GitHub](https://github.com/bossjones/goob_ai/issues). - -## License - -goob_ai is certified open source hardware. -[![OSHW](img/certification-mark-CH000020-wide-sm.png)](https://certification.oshwa.org/ch000020.html) - -All software in this project is licensed under [MIT](LICENSE). All hardware designs, images, and documentation are -licensed under [CC-BY-4.0](LICENSE_CC-BY-4.0). Copyright: 2021-2024, Reto Trappitsch diff --git a/docs/utilities.md b/docs/utilities.md index 5817cb44..ef65fa04 100644 --- a/docs/utilities.md +++ b/docs/utilities.md @@ -1,3 +1,3 @@ # PyPackage -::: src.utilities +::: src.goob_ai.utils diff --git a/mkdocs.yml b/mkdocs.yml index 0cace874..52cb73ba 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,5 @@ --- +dev_addr: 127.0.0.1:8888 site_url: https://goob_ai.readthedocs.io repo_url: https://github.com/bossjones/goob_ai site_author: bossjones @@ -94,27 +95,26 @@ plugins: # Want to have ezlinks after macros # because macros might return markup with ezlinks that we want expanded - e.g.: for people # - ezlinks # https://github.com/orbikm/mkdocs-ezlinks-plugin - - search # search functionality - # SOURCE: mkdocs-with-pdf - - with-pdf: - # cover_title: - cover_subtitle: GoobAI - # cover_logo: assets/images/banner.png - back_cover: true - toc_level: 2 - excludes_children: - - 'releases/changelog/:upgrading' - # convert_iframe: - # - src: https://streamable.com/e/zmtb00 - # img: https://cdn-cf-east.streamable.com/image/zmtb00-screenshot75403.jpg - two_columns_level: 3 - render_js: true - # headless_chrome_path: google-chrome - output_path: ../document.pdf - # debug_html: true - # verbose: true - # show_anchors: true - # enabled_if_env: ENABLE_PDF_EXPORT + # # SOURCE: mkdocs-with-pdf + # - with-pdf: + # # cover_title: + # cover_subtitle: GoobAI + # # cover_logo: assets/images/banner.png + # back_cover: true + # toc_level: 2 + # excludes_children: + # - 'releases/changelog/:upgrading' + # # convert_iframe: + # # - src: https://streamable.com/e/zmtb00 + # # img: https://cdn-cf-east.streamable.com/image/zmtb00-screenshot75403.jpg + # two_columns_level: 3 + # render_js: true + # # headless_chrome_path: google-chrome + # output_path: ../document.pdf + # # debug_html: true + # # verbose: true + # # show_anchors: true + # # enabled_if_env: ENABLE_PDF_EXPORT nav: - Home: index.md @@ -128,54 +128,17 @@ nav: - Developer Guide: dev.md - Acknowledgement: acknowledgement.md - Utilities: utilities.md -# plugins: -# - with-pdf: -# # author: WHO -# # copyright: ANY TEXT -# # -# # cover: false -# # back_cover: true -# # cover_title: TITLE TEXT -# # cover_subtitle: SUBTITLE TEXT -# # custom_template_path: TEMPLATES PATH -# # -# # toc_title: TOC TITLE TEXT -# # heading_shift: false -# # toc_level: 3 -# # ordered_chapter_level: 2 -# # excludes_children: -# # - 'release-notes/:upgrading' -# # - 'release-notes/:changelog' -# # -# # exclude_pages: -# # - 'bugs/' -# # - 'appendix/contribute/' -# # convert_iframe: -# # - src: IFRAME SRC -# # img: POSTER IMAGE URL -# # text: ALTERNATE TEXT -# # - src: ... -# # two_columns_level: 3 -# # -# # render_js: true -# # headless_chrome_path: headless-chromium -# # -# # output_path: any-place/document.pdf -# # enabled_if_env: ENABLE_PDF_EXPORT -# # -# # debug_html: true -# # show_anchors: true -# # verbose: true -# SOURCE: https://github.com/vinta/awesome-python/blob/master/mkdocs.yml -extra: - social: - - type: github - link: https://github.com/bossjones - - type: twitter - link: https://twitter.com/bossjones - - type: linkedin - link: https://www.linkedin.com/in/bossjones +# # SOURCE: https://github.com/vinta/awesome-python/blob/master/mkdocs.yml +# extra: +# social: +# - type: github +# link: https://github.com/bossjones +# - type: twitter +# link: https://twitter.com/bossjones +# - type: linkedin +# link: https://www.linkedin.com/in/bossjones + markdown_extensions: # Python Markdown - toc: