Bareos Project - Reference Implementation

Bareos Project - Excellent reference model implementation of Sphinx and ReadTheDocs and reStructuredText

Note

This page was Retrieved and copied April 11 2021

https://github.com/bareos/blob/bareos-20/docs/manuals/bareos/Introduction

This is a complete guide to the language and style conventions used for Bareos Documentation. The Sphinx tool has been used to produce a presentable documentation using the reStructuredText (reST) files present in https://github.com/bareos/tree/master/docs/manuals/source.

The primary output format is HTML. It is doubtfull, is PDFs can be created easily (internally, Sphinx would convert to Latex first, and than use Latex to create the PDF).

Contents:

• What is Bareos?
  • History
  • Who Needs Bareos?
  • Bareos Components or Services
  • Bareos Version Numbers and Releases
  • Bareos Packages
  • Quick Start
  • Terminology
  • What Bareos is Not
  • Interactions Between the Bareos Services
  • The Current State of Bareos
• reST Overview
  • Use of whitespace
  • Sphinx naming
  • Paragraphs
  • Inline markup
  • Lists, Definition Lists and Quotes
  • Literal block
  • Source Code
  • Hyperlinks
  • Cross-linking markup
  • Sections
  • Explicit Markup
  • File/Directory/Path
  • Note
  • Warning
  • Quote
  • Index
  • Image
  • Table
• Common Names
  • Bareos Names
  • Bareos Paths and Filenames
  • NDMP
  • Products
• Specific Formatting
  • Configuration
  • System Command
  • Unix Command Session
  • Windows
  • Environment Variable
  • SQL
  • Logging
  • Name
  • Volume Parameter
  • Operating System
  • Email Address
  • Backus–Naur form
  • Diagrams
• Bareos Specific Formatting
  • Document File Structure
  • Bareos Host Names
  • Bareos Configuration
  • Bconsole
  • Bareos Logging
  • Limitation
  • Issues tracked on Mantis
  • Releases
• Gotchas
  • sphinx-build
  • Not shown text
  • Undefined link targets
  • toctree vs include
  • :option:
• The bareos conf.py looks as follows
• Configuration File
  • Version 2
  • Version 1

Last change: Tue, 03 Aug 2021 10:25 PM UTC