chiark / gitweb /
docs wip
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Thu, 5 Aug 2021 10:33:11 +0000 (11:33 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Thu, 5 Aug 2021 10:33:11 +0000 (11:33 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
docs/conf.py
docs/config.rst [moved from README.config with 99% similarity]
docs/index.rst

index 7a58ede2bc91728336c5cffbf43195fb993202dc..f37c66fa66d1c6faf84f8c75160f5e4bbe7f4aac 100644 (file)
@@ -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'),
 ]
 
similarity index 99%
rename from README.config
rename to docs/config.rst
index 826c09fc4445decc03ac6a2f6d8100a6f75046cf..a9c2b49805ed3ed9994609b72b39710d910f9544 100644 (file)
@@ -1,4 +1,6 @@
--*- Fundamental -*-
+Configuration
+=============
+
 
 Sections
 
index d9bbff99fa81cf2b3d797122843cb9de36eb965c..13d8e7f19429809482d361f9bf65fa4d8d806a95 100644 (file)
@@ -6,7 +6,7 @@ Hippotat - Asinine IP over HTTP
    :caption: Contents:
 
    README
-
+   config.rst
 
 Indices and tables
 ==================