Guidedog / Documentation 0.2.0

Guidedog Manual

Write once. Explain well. Publish on the web and on paper.

Guidedog is a documentation generator that builds HTML websites and PDF books from reStructuredText and Markdown sources. It operates as a self-contained executable without requiring a Python environment or external LaTeX installation. The conversion engine is called Guidedoc; PDF pages are typeset using Typst, and the documentation website is generated directly.

A small project needs three things: a source document, a table of contents, and conf.toml. Start with Your first project. For a particular task, use Practical tasks. For an exact contract, use Reference.

Fig. 1 One source project, two publications.

Learn

• Tutorials

  • Your first project

  • Make a small book

• Topic guides

  • Authoring documents

  • Domains

  • How a project works

  • Mathematics and proofs

  • Diagrams that explain

  • Typography for reading

  • Templates

  • Images, video, audio, and downloads

  • Internationalization

  • Linking to other projects

  • Declaring object types

  • Documenting Python with autodoc

  • Documenting Odin

Work

• Practical tasks

  • Build and install Guidedog

  • Build and publish documentation

  • Move a Sphinx project

  • Document a codebase

  • Maintain this documentation

• Reference

  • Command-line reference

  • Configuration reference

  • Readers, renderers, and builders

  • Error messages

  • Compatibility with Sphinx

Understand

• Internals

  • The Guidedoc engine

  • Invariants before algorithms

  • Publish one complete generation

  • Memory and ownership

• About this manual

  • Build evidence

• Guidedog

  • Start a project

  • Install

  • Build from source

  • Translate with Guidedog

  • Read and embed

  • Credits and license

API reference

• API Reference