Analog Devices Doctools

Analog Devices Inc. documentation extensions, themes, and tools for multiple repositories in the organization.

Read the Documentation guidelines for more documentation rules and information on the directives and roles packaged on this repository.

And read the Command line interface for information about the command line interface provided by Doctools.

• Installing

  How to do a release install, and a development install of Doctools.

• Fundamentals

  Doctools is the central piece for aggregating multiple documentations together, expanding the standard hierarchical, mono-repo documentation configuration.

• Documentation guidelines

  A brief set-of-rules for the documentation.

• Command line interface

  The Doctools bundles a command line interface called adoc meant to ease both continuous integration and local builds of the documentation.

• Documentation deployment

  Doctools is developed to work offline, in a local server as a rolling release (e.g., on GitHub Pages) and versioned in a dedicated server with orchestration.

• Continuous integration

  Doctools has a continuous deployment integration pipeline that works as follows:

• Sphinx theme

  A Sphinx theme called harmonic (formerly cosmic) is available and is based on ADI’s harmonic design language.