diff options
| author | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2022-04-02 21:59:06 +0000 |
|---|---|---|
| committer | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2022-04-02 21:59:06 +0000 |
| commit | 8388cf82b89079e4ea39ce266b31580a2e5956c6 (patch) | |
| tree | 42b9871463ff8e70ccbcd03234baaf67a5eca43d /docs | |
| parent | c50e1b627f32a925d6558a21f8ecd4c2db9205a3 (diff) | |
| download | docutils-8388cf82b89079e4ea39ce266b31580a2e5956c6.tar.gz | |
Minimalistic menu bar for documentation pages.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9051 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs')
43 files changed, 121 insertions, 6 deletions
diff --git a/docs/api/publisher.txt b/docs/api/publisher.txt index d45bbb8d2..86f2affe1 100644 --- a/docs/api/publisher.txt +++ b/docs/api/publisher.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ======================== The Docutils Publisher ======================== diff --git a/docs/api/runtime-settings.txt b/docs/api/runtime-settings.txt index 7bfab71d0..87d10aa1b 100644 --- a/docs/api/runtime-settings.txt +++ b/docs/api/runtime-settings.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + =========================== Docutils Runtime Settings =========================== diff --git a/docs/api/transforms.txt b/docs/api/transforms.txt index 9013a7b5c..c8df2c165 100644 --- a/docs/api/transforms.txt +++ b/docs/api/transforms.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ===================== Docutils Transforms ===================== diff --git a/docs/dev/distributing.txt b/docs/dev/distributing.txt index 6fa30f4b0..6ec3b15bd 100644 --- a/docs/dev/distributing.txt +++ b/docs/dev/distributing.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + =============================== Docutils_ Distributor's Guide =============================== diff --git a/docs/dev/hacking.txt b/docs/dev/hacking.txt index 17f7d7106..eb78b0f71 100644 --- a/docs/dev/hacking.txt +++ b/docs/dev/hacking.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ========================== Docutils_ Hacker's Guide ========================== diff --git a/docs/dev/policies.txt b/docs/dev/policies.txt index df927a799..6a909c9a5 100644 --- a/docs/dev/policies.txt +++ b/docs/dev/policies.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + =========================== Docutils Project Policies =========================== @@ -676,7 +678,6 @@ the Docutils-develop_ mailing list. .. _link list: https://docutils.sourceforge.io/docs/user/links.html .. _docutils-develop: docs/user/mailing-lists.html#docutils-develop - .. Local Variables: diff --git a/docs/dev/pysource.txt b/docs/dev/pysource.txt index 190781f39..87c1e0b6e 100644 --- a/docs/dev/pysource.txt +++ b/docs/dev/pysource.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ====================== Python Source Reader ====================== @@ -121,6 +123,7 @@ roles may be defined. .. _pysource.dtd: pysource.dtd .. _docutils.dtd: ../ref/docutils.dtd + .. Local Variables: diff --git a/docs/dev/release.txt b/docs/dev/release.txt index 4d07186b9..c6888d07b 100644 --- a/docs/dev/release.txt +++ b/docs/dev/release.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ============================= Docutils_ Release Procedure ============================= diff --git a/docs/dev/repository.txt b/docs/dev/repository.txt index 7516959b4..46a52c75e 100644 --- a/docs/dev/repository.txt +++ b/docs/dev/repository.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ===================================== The Docutils_ Version Repository ===================================== diff --git a/docs/dev/rst/alternatives.txt b/docs/dev/rst/alternatives.txt index 01af73248..1500e7548 100644 --- a/docs/dev/rst/alternatives.txt +++ b/docs/dev/rst/alternatives.txt @@ -1,3 +1,5 @@ +.. include:: ../../header2.txt + ================================================== A Record of reStructuredText Syntax Alternatives ================================================== @@ -3201,7 +3203,6 @@ We need syntax for `object references`_. .. _object references: ../todo.html#object-numbering-and-object-references - .. Local Variables: diff --git a/docs/dev/rst/problems.txt b/docs/dev/rst/problems.txt index f44774263..7762452b8 100644 --- a/docs/dev/rst/problems.txt +++ b/docs/dev/rst/problems.txt @@ -1,3 +1,5 @@ +.. include:: ../../header2.txt + ============================== Problems With StructuredText ============================== diff --git a/docs/dev/runtime-settings-processing.txt b/docs/dev/runtime-settings-processing.txt index 6df15a925..11d356629 100644 --- a/docs/dev/runtime-settings-processing.txt +++ b/docs/dev/runtime-settings-processing.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ============================= Runtime Settings Processing ============================= diff --git a/docs/dev/semantics.txt b/docs/dev/semantics.txt index 15dcadd31..68a3020b6 100644 --- a/docs/dev/semantics.txt +++ b/docs/dev/semantics.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ===================== Docstring Semantics ===================== diff --git a/docs/dev/testing.txt b/docs/dev/testing.txt index cee791162..2a18fcd86 100644 --- a/docs/dev/testing.txt +++ b/docs/dev/testing.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + =================== Docutils_ Testing =================== diff --git a/docs/dev/todo.txt b/docs/dev/todo.txt index d1437142d..c9ff020c0 100644 --- a/docs/dev/todo.txt +++ b/docs/dev/todo.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ====================== Docutils_ To Do List ====================== @@ -2877,10 +2879,10 @@ Front-End Tools .. _partial parsing: https://docs.python.org/3/library/argparse.html#partial-parsing - .. _configuration: ../user/config.html .. _transforms: ../api/transforms.html + .. Local Variables: diff --git a/docs/dev/website.txt b/docs/dev/website.txt index 222cc3c8c..444372884 100644 --- a/docs/dev/website.txt +++ b/docs/dev/website.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + =================== Docutils Web Site =================== diff --git a/docs/header.txt b/docs/header.txt new file mode 100644 index 000000000..6bc85f751 --- /dev/null +++ b/docs/header.txt @@ -0,0 +1,14 @@ +.. Minimal menu bar for inclusion in documentation sources + in ``docutils/docs/*/`` sub-diretories. + + Attention: this is not a standalone document. + +.. header:: + Docutils__ | Overview__ | About__ | Users__ | Reference__ | Developers__ + + __ https://docutils.sourceforge.io + __ ../index.html + __ ../index.html#project-fundamentals + __ ../index.html#user + __ ../index.html#ref + __ ../index.html#howto diff --git a/docs/header2.txt b/docs/header2.txt new file mode 100644 index 000000000..53f595168 --- /dev/null +++ b/docs/header2.txt @@ -0,0 +1,15 @@ +.. Minimal menu bar for inclusion in documentation sources + in ``docutils/docs/*/`` sub-sub-diretories. + + Attention: this is not a standalone document. + +.. header:: + Docutils__ | Overview__ | About__ | Users__ | Reference__ | Developers__ + + __ https://docutils.sourceforge.io + + __ ../../index.html + __ ../../index.html#project-fundamentals + __ ../../index.html#user + __ ../../index.html#ref + __ ../../index.html#howto diff --git a/docs/howto/cmdline-tool.txt b/docs/howto/cmdline-tool.txt index 5c1da0f22..e4c4344c1 100644 --- a/docs/howto/cmdline-tool.txt +++ b/docs/howto/cmdline-tool.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + =============================================== Inside A Docutils Command-Line Front-End Tool =============================================== diff --git a/docs/howto/html-stylesheets.txt b/docs/howto/html-stylesheets.txt index aee700138..089e34d0c 100644 --- a/docs/howto/html-stylesheets.txt +++ b/docs/howto/html-stylesheets.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ============================================== Writing HTML (CSS) Stylesheets for Docutils_ ============================================== @@ -84,7 +86,6 @@ Docutils' HTML code in a separate stylesheet. .. _stylesheet collection: ../../../sandbox/stylesheets/ - .. Local Variables: diff --git a/docs/howto/i18n.txt b/docs/howto/i18n.txt index 85f99c95f..0f77c08d2 100644 --- a/docs/howto/i18n.txt +++ b/docs/howto/i18n.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ================================ Docutils_ Internationalization ================================ diff --git a/docs/howto/rst-directives.txt b/docs/howto/rst-directives.txt index 9e23f80ff..af918c2ea 100644 --- a/docs/howto/rst-directives.txt +++ b/docs/howto/rst-directives.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ======================================= Creating reStructuredText_ Directives ======================================= diff --git a/docs/howto/rst-roles.txt b/docs/howto/rst-roles.txt index 7bfcc3de7..334260fa4 100644 --- a/docs/howto/rst-roles.txt +++ b/docs/howto/rst-roles.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ================================================== Creating reStructuredText Interpreted Text Roles ================================================== diff --git a/docs/howto/security.txt b/docs/howto/security.txt index b087359ae..58afa513f 100644 --- a/docs/howto/security.txt +++ b/docs/howto/security.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ============================= Deploying Docutils Securely ============================= diff --git a/docs/index.txt b/docs/index.txt index 446f89a3d..0f85ddecd 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -1,5 +1,5 @@ ========================================== - Docutils_ Project Documentation Overview + Docutils Project Documentation Overview ========================================== :Author: David Goodger @@ -14,6 +14,15 @@ from the ``docs`` directory of the `Docutils distribution`_. .. _Docutils: https://docutils.sourceforge.io/ .. _Docutils distribution: https://docutils.sourceforge.io/#download +.. header:: + Docutils_ | Overview | About__ | Users__ | Reference__ | Developers__ + +__ `project fundamentals`_ +__ user_ +__ ref_ +__ howto_ + + .. contents:: diff --git a/docs/ref/doctree.txt b/docs/ref/doctree.txt index a226da828..f16021629 100644 --- a/docs/ref/doctree.txt +++ b/docs/ref/doctree.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ============================ The Docutils Document Tree ============================ diff --git a/docs/ref/rst/definitions.txt b/docs/ref/rst/definitions.txt index d2eff2532..7584f2126 100644 --- a/docs/ref/rst/definitions.txt +++ b/docs/ref/rst/definitions.txt @@ -1,3 +1,5 @@ +.. include:: ../../header2.txt + ============================================ reStructuredText Standard Definition Files ============================================ diff --git a/docs/ref/rst/directives.txt b/docs/ref/rst/directives.txt index b49a239f6..038532829 100644 --- a/docs/ref/rst/directives.txt +++ b/docs/ref/rst/directives.txt @@ -1,3 +1,5 @@ +.. include:: ../../header2.txt + ============================= reStructuredText Directives ============================= diff --git a/docs/ref/rst/introduction.txt b/docs/ref/rst/introduction.txt index 8c34a64b1..4b9768e58 100644 --- a/docs/ref/rst/introduction.txt +++ b/docs/ref/rst/introduction.txt @@ -1,3 +1,5 @@ +.. include:: ../../header2.txt + ===================================== An Introduction to reStructuredText ===================================== diff --git a/docs/ref/rst/mathematics.txt b/docs/ref/rst/mathematics.txt index ecd063775..6e8b703cf 100644 --- a/docs/ref/rst/mathematics.txt +++ b/docs/ref/rst/mathematics.txt @@ -1,3 +1,5 @@ +.. include:: ../../header2.txt + ============================ LaTeX syntax for mathematics ============================ diff --git a/docs/ref/rst/restructuredtext.txt b/docs/ref/rst/restructuredtext.txt index e28a59466..254204d29 100644 --- a/docs/ref/rst/restructuredtext.txt +++ b/docs/ref/rst/restructuredtext.txt @@ -1,5 +1,7 @@ .. -*- coding: utf-8 -*- +.. include:: ../../header2.txt + ======================================= reStructuredText Markup Specification ======================================= diff --git a/docs/ref/rst/roles.txt b/docs/ref/rst/roles.txt index 1d077165f..f2874d55c 100644 --- a/docs/ref/rst/roles.txt +++ b/docs/ref/rst/roles.txt @@ -1,3 +1,5 @@ +.. include:: ../../header2.txt + ========================================= reStructuredText Interpreted Text Roles ========================================= diff --git a/docs/user/config.txt b/docs/user/config.txt index 0af775003..2a5464c2e 100644 --- a/docs/user/config.txt +++ b/docs/user/config.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ======================== Docutils Configuration ======================== diff --git a/docs/user/emacs.txt b/docs/user/emacs.txt index 2bf28a785..8c12a1357 100644 --- a/docs/user/emacs.txt +++ b/docs/user/emacs.txt @@ -1,5 +1,7 @@ .. -*- coding: utf-8 -*- +.. include:: ../header.txt + ======================================== Emacs Support for reStructuredText ======================================== diff --git a/docs/user/html.txt b/docs/user/html.txt index 2b7f9e551..d5099c10a 100644 --- a/docs/user/html.txt +++ b/docs/user/html.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ===================== Docutils HTML writers ===================== diff --git a/docs/user/latex.txt b/docs/user/latex.txt index 82b01ca19..58fcd8e7d 100644 --- a/docs/user/latex.txt +++ b/docs/user/latex.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ================================ Generating LaTeX with Docutils ================================ diff --git a/docs/user/links.txt b/docs/user/links.txt index 451f5338f..2f0425de8 100644 --- a/docs/user/links.txt +++ b/docs/user/links.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ===================== Docutils_ Link List ===================== diff --git a/docs/user/mailing-lists.txt b/docs/user/mailing-lists.txt index 20a8bd639..55ba619db 100644 --- a/docs/user/mailing-lists.txt +++ b/docs/user/mailing-lists.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ========================= Docutils_ Mailing Lists ========================= diff --git a/docs/user/manpage.txt b/docs/user/manpage.txt index 1c686163f..d1dc28a51 100644 --- a/docs/user/manpage.txt +++ b/docs/user/manpage.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ============================== manpage writer for Docutils_ ============================== diff --git a/docs/user/odt.txt b/docs/user/odt.txt index 115c3250a..cbe6e4ba5 100644 --- a/docs/user/odt.txt +++ b/docs/user/odt.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ======================= Odt Writer for Docutils ======================= @@ -16,7 +18,6 @@ Odt Writer for Docutils .. contents:: - Introduction ============ diff --git a/docs/user/rst/quickstart.txt b/docs/user/rst/quickstart.txt index 8b62afcb8..d141215cf 100644 --- a/docs/user/rst/quickstart.txt +++ b/docs/user/rst/quickstart.txt @@ -1,3 +1,5 @@ +.. include:: ../../header2.txt + A ReStructuredText Primer ========================= diff --git a/docs/user/smartquotes.txt b/docs/user/smartquotes.txt index 97536639c..01357cf06 100644 --- a/docs/user/smartquotes.txt +++ b/docs/user/smartquotes.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ========================= Smart Quotes for Docutils ========================= diff --git a/docs/user/tools.txt b/docs/user/tools.txt index b9f96ea2c..fb4a38f6d 100644 --- a/docs/user/tools.txt +++ b/docs/user/tools.txt @@ -1,3 +1,5 @@ +.. include:: ../header.txt + ========================== Docutils Front-End Tools ========================== |