From: Ian Jackson Date: Thu, 5 Aug 2021 10:33:11 +0000 (+0100) Subject: docs wip X-Git-Tag: hippotat/1.0.0~318 X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ian/git?a=commitdiff_plain;h=c7f66b90182a787d939427d3a4181b7a516d6fde;p=hippotat.git docs wip Signed-off-by: Ian Jackson --- diff --git a/docs/conf.py b/docs/conf.py index 7a58ede..f37c66f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,8 +19,8 @@ # -- Project information ----------------------------------------------------- -project = 'Otter' -copyright = '2021 Ian Jackson and the contributors to Otter' +project = 'Hippotat' +copyright = '2021 Ian Jackson and the contributors to Hippotat' author = 'Ian Jackson et al' # The short X.Y version @@ -115,7 +115,7 @@ html_static_path = ['_static'] # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = 'Otterdoc' +htmlhelp_basename = 'Hippotatdoc' # -- Options for LaTeX output ------------------------------------------------ @@ -142,8 +142,8 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'Otter.tex', 'Otter Documentation', - 'Ian Jackson and the contributors to Otter', 'manual'), + (master_doc, 'Hippotat.tex', 'Hippotat Documentation', + 'Ian Jackson and the contributors to Hippotat', 'manual'), ] @@ -152,7 +152,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'otter', 'Otter Documentation', + (master_doc, 'otter', 'Hippotat Documentation', [author], 1) ] @@ -163,8 +163,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'Otter', 'Otter Documentation', - author, 'Otter', 'Online Table Top Environment Renderer', + (master_doc, 'Hippotat', 'Hippotat Documentation', + author, 'Hippotat', 'Online Table Top Environment Renderer', 'Games'), ] diff --git a/README.config b/docs/config.rst similarity index 99% rename from README.config rename to docs/config.rst index 826c09f..a9c2b49 100644 --- a/README.config +++ b/docs/config.rst @@ -1,4 +1,6 @@ --*- Fundamental -*- +Configuration +============= + Sections diff --git a/docs/index.rst b/docs/index.rst index d9bbff9..13d8e7f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,7 @@ Hippotat - Asinine IP over HTTP :caption: Contents: README - + config.rst Indices and tables ==================