Developer Docs (if you’re going to contribute code)

Developer Install

Use git to clone the repository:

git clone http://github.com/OpenMDAO/OpenMDAO

Use pip to install openmdao locally:

cd OpenMDAO

pip install -e .

Note

The -e option tells pip to install directly from your repository. This is very useful when you’re developing because when you change the code or pull new commits down from GitHub, you don’t necessarily need to re-run the pip install.

Building the Docs

You can read the docs online, so it is not necessary to build them locally on your machine. But if you’re going to build new features or add new examples, you’ll want to build the docs locally, so that you can check them while you are writing them.

• Local Building of OpenMDAO Documentation
  • make clean
  • make all / make html
  • make html-update / make
  • make single <filename>
• Automating Doc Build and Custom Doc Deployment from Travis CI
  • Getting Started and General Concept
  • Specific Commands
• Caching on Travis CI

Creating Your Own OpenMDAO Plugins

• ‘Typical’ Plugins
• CaseReader Plugins
• Command Line Tool Plugins
• Local Discovery
• Global Discovery Using github
• Global Discovery Using PyPI
• Plugin Creation from Scratch
• Converting Existing Classes to Plugins
• Plugin Checklist

Documentation Style Guide

This document exists to help OpenMDAO documentation writers follow appropriate guidelines, in terms of formatting and embedding code.

• OpenMDAO Docs Style Guide
  • General Docstring Conventions
  • Embedding Autodocumentation Snippets into Documentation
  • Adding a Link to an Autodoc Class in a .rst File
  • Custom Directives for Embedding Items into OpenMDAO Documentation
  • Tagging
• Sphinx and Decorated Methods