.. -*- coding: utf-8 -*- .. role:: sref(numref) .. role:: xref(numref) .. Copyright (C) 2018, 2019, 2021 Wolfgang Scherer, .. This file is part of Documentation Standard. .. Permission is granted to copy, distribute and/or modify this document .. under the terms of the GNU Free Documentation License, Version 1.3 .. or any later version published by the Free Software Foundation; .. with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. .. A copy of the license is included in the section entitled "GNU .. Free Documentation License". .. inline comments (with du_comment_role) .. role:: rem(comment) .. role:: html(raw) :format: html .. role:: shx(code) :language: sh .. >>CODD Introduction .. rst-class:: narrow xmedium xlarge xhuge xultra .. _`sec:Introduction`: ================================================== :rem:`|||:sec:|||`\ Introduction ================================================== The documentation framework described in |chapter-sphinx-doc|, supports single file articles and books with chapters and fully configurable build environment. With a separate doc directory, a subset of chapters can be built as a book part. The documentation is processed with the `Sphinx`_ document generator to produce various output formats (see |chapter-sphinx|). The theory behind `Sphinx Doc` is discussed in |chapter-relevance|. The reasons for advanced concepts like document snippets, which expand the traditional knowledge collection beyond simple cross referencing (hyperlinks), are discussed in |chapter-knowledge|. .. >>CODD Chapter .. >>CODD Conclusion .. >>CODD Appendix A .. \|:here:| .. >>CODD Notes .. ================================================== .. :rem:`|||:sec:|||`\ Footnotes .. ================================================== :html:`
` .. \[#] .. \|:info:| put local references here .. \|:info:| put local definitions here .. include:: doc_defs.inc .. include:: abbrev_defs.inc .. include:: doc_defs_combined.inc .. .. \||<-snap->|| doc_standalone .. include:: doc/doc_defs_secret.inc .. \||<-snap->|| doc_standalone .. \||<-snap->|| not_doc_standalone .. include:: doc_defs_secret.inc .. \||<-snap->|| not_doc_standalone .. _`Wolfgang Scherer`: wolfgang.scherer@gmx.de