feat: enable <make html> generation instruction

This commit is contained in:
dancingCycle 2022-11-14 15:28:07 +01:00
parent 0180f1dc31
commit 743f7ccfe8
7 changed files with 181 additions and 0 deletions

3
.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
build
venv
*.*~

20
Makefile Normal file
View File

@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

78
source/conf.py Normal file
View File

@ -0,0 +1,78 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'Handbuch'
copyright = '2022, <tdb>'
author = 'Software Ingenieur Begerad (SIB)'
# The full version, including alpha/beta/rc tags
release = '0.1.0'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'myst_parser'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['*~','readme.md*']
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# -- Options for LaTex output -------------------------------------------------
latex_elements = {
'papersize': r'a4paper',
'fontpkg': r'''
%\usepackage[default]{lato}
%\setmainfont{DejaVu Serif}
%\setsansfont{DejaVu Sans}
%\setmonofont{DejaVu Sans Mono}
''',
'preamble': r'''
\usepackage[titles]{tocloft}
\cftsetpnumwidth {1.25cm}\cftsetrmarg{1.5cm}
\setlength{\cftchapnumwidth}{0.75cm}
\setlength{\cftsecindent}{\cftchapnumwidth}
\setlength{\cftsecnumwidth}{1.25cm}
''',
'fncychap': r'\usepackage[Bjornstrup]{fncychap}',
'printindex': r'\footnotesize\raggedright\printindex',
}
latex_show_urls = 'footnote'

22
source/index.rst Normal file
View File

@ -0,0 +1,22 @@
.. dcmnttn documentation master file, created by
sphinx-quickstart on Tue Nov 8 08:21:48 2022.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
RTFM - Das Handbuch der Free Fleet Management Initiative
========================================================
.. toctree::
:maxdepth: 2
:caption: Contents:
manual/imprint
manual/introduction
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

19
source/manual/imprint.md Normal file
View File

@ -0,0 +1,19 @@
# Imprint
© / Copyright: 2022 //TODO tbd
% Auflage (soweit nicht Erstauflage)
% Umschlaggestaltung, Illustration: vollständiger Name bzw. Institution
% Lektorat, Korrektorat: vollständiger Name bzw. Institution
% Übersetzung: vollständiger Name bzw. Institution
% Weitere Mitwirkende: vollständiger Name bzw. Institution
Verlag:
//TODO tbd
% Druck: Name und Ort der Druckerei
% ISBN Paperback: 978-3-XXXX-XXXX-X
% ISBN Hardcover: 978-3-XXXX-XXXX-X
% ISBN e-Book: 978-3-XXXX-XXXX-X

View File

@ -0,0 +1,3 @@
# Introduction
//TODO tbc

36
source/readme.md Normal file
View File

@ -0,0 +1,36 @@
# 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