planktoscope/mkdocs.yml

site_name: PlanktoScope
nav:
    - Setup:
        - Basic Install: easy_install.md
        - Expert Setup: expert_setup.md
        - Remote Access: remote_access.md
    - Assembly:
        - Assembly guide: assembly_guide.md
    - Usage:
        - Getting started: getting_started.md
        - User Interface: ui_guide.md
        - Collection devices: collection_devices.md
    - Hardware:
        - Planktoscope HAT: hat_hardware.md
    - Under the hood:
        - Software architecture: software_architecture.md
        - MQTT Messages: mqtt_messages.md
        - Create Master SD Card: create_sd.md
        - Update the Device Tree: update_device-tree.md
    - Changelog:
        - Changelog: changelog.md
    - Contribute:
        - Edit this documentation: edit_this_doc.md
        - Edit the code: edit_the_code.md
    - About:
        - License: license.md
theme:
    name: readthedocs

markdown_extensions:
    - smarty
    - sane_lists
    - admonition
    - toc:
        permalink: true
Update to documentation to use RTD with mkdocs locally Initial setup for Read The Doc using mkdocs to build the documentation. Most of the doc still needs to be rewritten (Expert Setup is the only part using MD for now). 2020-09-17 13:40:00 +02:00			`site_name: PlanktoScope`
			`nav:`
			`- Setup:`
basic doc structure in place 2020-09-28 13:33:52 +02:00			`- Basic Install: easy_install.md`
Update to documentation to use RTD with mkdocs locally Initial setup for Read The Doc using mkdocs to build the documentation. Most of the doc still needs to be rewritten (Expert Setup is the only part using MD for now). 2020-09-17 13:40:00 +02:00			`- Expert Setup: expert_setup.md`
Add admonition configuration 2020-09-28 21:34:37 +02:00			`- Remote Access: remote_access.md`
mkdocs: add assembly guide 2020-10-06 12:32:38 +02:00			`- Assembly:`
			`- Assembly guide: assembly_guide.md`
Update to documentation to use RTD with mkdocs locally Initial setup for Read The Doc using mkdocs to build the documentation. Most of the doc still needs to be rewritten (Expert Setup is the only part using MD for now). 2020-09-17 13:40:00 +02:00			`- Usage:`
Doc: add getting started page, and wifi section in the ui guide 2021-03-11 15:45:11 +01:00			`- Getting started: getting_started.md`
docs: update mkdocs.yml 2021-02-22 17:59:17 +01:00			`- User Interface: ui_guide.md`
Update to documentation to use RTD with mkdocs locally Initial setup for Read The Doc using mkdocs to build the documentation. Most of the doc still needs to be rewritten (Expert Setup is the only part using MD for now). 2020-09-17 13:40:00 +02:00			`- Collection devices: collection_devices.md`
docs: add hat hardware information 2021-02-22 21:08:46 +01:00			`- Hardware:`
			`- Planktoscope HAT: hat_hardware.md`
basic doc structure in place 2020-09-28 13:33:52 +02:00			`- Under the hood:`
			`- Software architecture: software_architecture.md`
			`- MQTT Messages: mqtt_messages.md`
Documentation update Addition of ribbon assembly detail Addition of sdcard creation guide Update to the image Make sure it's PlanktoScope everywhere 2020-10-14 13:04:07 +02:00			`- Create Master SD Card: create_sd.md`
docs: update mkdocs.yml 2021-02-22 17:59:17 +01:00			`- Update the Device Tree: update_device-tree.md`
Changelog addition 2020-10-14 16:30:32 +02:00			`- Changelog:`
			`- Changelog: changelog.md`
basic doc structure in place 2020-09-28 13:33:52 +02:00			`- Contribute:`
Add admonition configuration 2020-09-28 21:34:37 +02:00			`- Edit this documentation: edit_this_doc.md`
basic doc structure in place 2020-09-28 13:33:52 +02:00			`- Edit the code: edit_the_code.md`
Update to documentation to use RTD with mkdocs locally Initial setup for Read The Doc using mkdocs to build the documentation. Most of the doc still needs to be rewritten (Expert Setup is the only part using MD for now). 2020-09-17 13:40:00 +02:00			`- About:`
			`- License: license.md`
			`theme:`
License! Martyr proposal 2020-09-28 22:10:33 +02:00			`name: readthedocs`
Update to documentation to use RTD with mkdocs locally Initial setup for Read The Doc using mkdocs to build the documentation. Most of the doc still needs to be rewritten (Expert Setup is the only part using MD for now). 2020-09-17 13:40:00 +02:00
			`markdown_extensions:`
			`- smarty`
			`- sane_lists`
Add admonition configuration 2020-09-28 21:34:37 +02:00			`- admonition`
Update to documentation to use RTD with mkdocs locally Initial setup for Read The Doc using mkdocs to build the documentation. Most of the doc still needs to be rewritten (Expert Setup is the only part using MD for now). 2020-09-17 13:40:00 +02:00			`- toc:`
			`permalink: true`