From c631d90a3d4ad87ab8bf331a4d35366dd718c019 Mon Sep 17 00:00:00 2001 From: "Begerad, Stefan" Date: Fri, 21 Oct 2022 15:14:11 +0200 Subject: [PATCH] feat: enable instruction: make bundle --- .gitignore | 3 ++ Makefile | 33 +++++++++++++++++++++ source/conf.py | 76 ++++++++++++++++++++++++++++++++++++++++++++++++ source/index.rst | 13 +++++++++ 4 files changed, 125 insertions(+) create mode 100644 .gitignore create mode 100644 Makefile create mode 100644 source/conf.py create mode 100644 source/index.rst diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ae6894a --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +venv +*~ +.*~ diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..8d6c827 --- /dev/null +++ b/Makefile @@ -0,0 +1,33 @@ +# 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) + +.PHONY: sphinx bundle + +clean: + -rm -rf build/* + -rm -rf bundle/* + +sphinx: + $(MAKE) latexpdf + +bundle: sphinx + -mkdir bundle + cp build/latex/*.pdf bundle/ diff --git a/source/conf.py b/source/conf.py new file mode 100644 index 0000000..05d5090 --- /dev/null +++ b/source/conf.py @@ -0,0 +1,76 @@ +# 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('.')) +#sys.path.insert(0, os.path.abspath('..')) + + + +# -- Project information ----------------------------------------------------- + +project = 'Manual' +copyright = '2022, Stefan Ingenieur Begerad (SIB)' +author = 'Contributors' + +# 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'] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'en' + +# 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 = [] + +myst_url_schemes = ['http', 'https', 'mailto', 'ftp', 'mumble'] + + +# -- 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' diff --git a/source/index.rst b/source/index.rst new file mode 100644 index 0000000..b3a91dc --- /dev/null +++ b/source/index.rst @@ -0,0 +1,13 @@ +Manual +=========================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + manual/intro.md + manual/foo.md + manual/blub/index.rst + +Indices and tables +==================