User guide

Configuration

• Overview of technote configuration
  • The technote.toml and conf.py files
  • Primer on TOML
  • How the configuration system works with the Sphinx build
• Specifying authors and contributors in technote.toml
  • Minimal author metadata
  • Multiple authors
  • Additional author metadata
  • Adding affiliations
  • Non-author contributors
• Describing the document status (draft, deprecated, or stable)
  • Setting “draft” status
  • Setting “stable” status
  • Setting “deprecated” status
  • Setting “other” status
• Configuring the Sphinx build
  • Adding Sphinx extensions
  • Link to other documentation with intersphinx
  • Configuring the “nitpick” settings
  • Configuring the linkcheck builder
  • Directly configuring Sphinx and extensions
• technote.toml reference
  • Configuration errors
  • [technote]
  • [[technote.authors]]
  • [[technote.authors.affiliations]]
  • [[technote.contributors]]
  • [technote.status]
  • [[technote.status.superseding_urls]]
  • [technote.license]
  • [technote.sphinx]
  • [technote.sphinx.intersphinx]
  • [technote.sphinx.intersphinx.projects]
  • [technote.sphinx.linkcheck]
  • [technote.lint]

Curation

• Metadata published by technote
  • Standard HTML metadata
  • Highwire Press metadata
  • OpenGraph metadata
  • Dublin Core metadata
  • schema.org metadata
  • microformats2 metadata
  • Element data attributes

Theming

• Theming an organizations’s technotes