Skip to content

Latest commit

 

History

History
114 lines (82 loc) · 2.64 KB

index.rst

File metadata and controls

114 lines (82 loc) · 2.64 KB
Raw
topic

latex

\cleardoublepage\phantomsection

PREAMBLE

centered

Excerpts from the Sphinx Tutorial by Eric Holscher and Documentation Style Guide by Bareos GmbH & Co. KG and others. See [juh2019swdocwspx] for an introduction to Sphinx.

This documentation is built using , a static-site generator designed to create structured, semantic, and internally consistent documentation. Source documents are written in , a semantic, extensible markup syntax similar to Markdown.

  • reStructuredText Primer <quickstart> --Introduction to reStructuredText
    • reStructuredText Quick Reference <quickref>
    • reStructuredText 1-page cheat sheet <cheatsheet>
  • Sphinx Markup <sphinx:usage/restructuredtext/index> --Detailed guide to Sphinx's markup concepts and reStructuredText extensions

Note

and can be very flexible. For the sake of consistency and maintainability, this how to guide is highly opinionated about how documentation source files are organized and marked up.

concepts extensions themes cheatsheet

\appendix

appendix glossary indexlol indexlot indexlof indexloe indexlod indexloi bibliography

html or man or texinfo or text

Lists and References:

  • /appendix
  • /glossary
  • /indexlol
  • /indexlot
  • /indexlof
  • /indexloe
  • /indexlod
  • /indexloi
  • /bibliography
  • genindex

man or texinfo or text

html or man or texinfo or text