Analog Devices Doctools

Doctools: Enterprise scale docs-as-code

A documentation page surrounded by icons, abstract.

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

Read the Documentation guidelines for writing conventions and the directives and roles provided by Doctools. See the Command line interface for the command line tools used to preview, build, and combine documentation.

Documentation

  • Installing

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

  • Fundamentals

    What belongs to this tool and core principles.

  • Documentation guidelines

    The documentation is written in reStructuredText (reST) and built with Sphinx and Doctools for HTML and PDF output. For installation and build commands, see install and cli.

  • 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.