manual/source
Begerad, Stefan b38807c62a
All checks were successful
continuous-integration/drone/push Build is passing
feat: reduce project name
2022-11-22 15:11:21 +01:00
..
manual feat: add use case Paketmitnahne to introduction section 2022-11-17 14:15:15 +01:00
conf.py feat: reduce project name 2022-11-22 15:11:21 +01:00
index.rst chore: adjust working title 2022-11-17 12:08:38 +01:00
readme.md feat: enable <make html> generation instruction 2022-11-14 15:28:07 +01:00

Introduction

This is the source directory of the Sphinx documentation generator.

Build

You can build HTML files like this.

sphinx-build -b html <sourcedir> <builddir>

Configuration

Markdown

Configure Sphinx for Markdown support like this.

https://www.sphinx-doc.org/en/master/usage/markdown.html

NOTE: Make sure to add 'myst_parser' to extension to the configuration.

Exclude Documentation

Add all files and folders to be excluded from the generation to exclude_patterns.

File System

  • conf.ph: Sphinx configuration file
  • index.rst: root document serves as welcome page and contains root of ToC
  • manual: folder containing source files
  • readme.md: this file