HART Avionics - EECS Documentation

Table of Contents

• About the Project
  • Built with
• Getting Started
  • Prerequisites
  • Installing
• Usage

• Roadmap
• Contributing
• License
• Contacts
• Support the Project

About the Project

This is the documentation repo for the Oregon State Univerity AIAA High Altitude Rocket Team's ECE & CS avionics sub-team. This covers any system-wide and user-level documentation for the project. For more detailed documentation on project internals and developer documentation, see the corresponding project's repository.

Built with

• Sphinx documentation generator
• TexLive

Getting Started

Prerequisites

• pip

  $ sudo apt-get install python3-pip

• Sphinx documentation generator

  $ pip3 install -U sphinx

  Make sure ~/.local/bin is added to PATH

• GNU make

  $ sudo apt-get install build-essential

• recommonmark

  $ pip3 install recommonmark

If you plan on building LaTeX PDF documentation, you'll also need the following packages:

$ sudo apt-get install texlive-latex-recommended texlive-fonts-recommended texlive-latex-extra latexmk

Installing

1. Clone the repo

   $> git clone https://github.com/HART-Avionics/docs.git

Usage

The manual documentation is written mostly in Markdown, but Sphinx also has it's own default markup format called reStructuredText which can be used for generating documentation from code. Once you're finished making changes, you can build the documentation.

$ make build

Sphinx will try to generate both HTML & LaTeX PDF documentation in a build directory. The PDF (if generated successfully) is copied into the root directory and renamed ProjectCharter.pdf. These options can be configured in the project Makefile.

For more examples, please refer to the official Sphinx documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GNU GPLv3 License. See LICENSE for more information.

Contacts

Maintainer: Samuel D. Villegas - villegsa@oregonstate.edu

Support the Project

Donate to HART