FED3

Date: Sep 07, 2022

This site provides documentation for FED3. FED3 is an open-source battery-powered device for home-cage training of mice in operant tasks. FED3 can be 3D printed and the control code is open-source and can be modified. The code is written in the Arduino language and is run on a Feather M0 Adalogger microcontroller inside of FED3.

This site is currently under construction

It will eventually include the following information:

• Point 1

• Point 2

• Point 3

What to customize

Each documentation page is saved as an individual .rst file in the ‘source’ folder. Docs are written primarily in reStructuredText, and HTML can be used within the .rst file. Images are saved under _static. Besides obviously customizing the content of the pages, you will need to make sure to update:

• license (at the end of primary index page)

• conf.py:

  • project = “OE docs” # change to your project name

  • “github_repo”: “doc-template”, # change to new repo

  • html_logo = “_static/images/oe_logo_template.svg” # change to svg with your logo

    Change the device name on the logo “oe_logo_name.svg” Miso, Bold, 36 pt, Kerning: Optical Be sure to expand text before saving as .svg as Miso will not load as font.

• theme_overrides.css

  • Change overhead navigation bar colour (.navbar { background: yourfavecolour })

• .github/workflows/sphinx-build.yml

  • git clone https://github.com/open-ephys/doc-template.git # change to your repo

Getting Started

TOPIC 1

TOPIC 2

TOPIC 3

TOPIC 4 IS EXTERNAL LINK

License

This work is licensed under CC BY-SA 4.0.

To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/

next

About