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

  What belongs to this tool and core principles.

• Documentation guidelines

  A brief set-of-rules for the documentation.

• Command line interface

  "Serve" launches a live doc server, "custom doc" generates a custom html or pdf, with only the content that matters, and "aggregate" builds all docs at once.

• 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

  Continuous deployment pipeline and instructions to set up a self-hosted GitHub Actions runner using Podman or Docker and systemd without root.

• Sphinx theme

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