A shpynx temaplte for a reference manual

docs/RefMan/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+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)

docs/RefMan/RefMan.rst

@@ -0,0 +1,139 @@
+.. Cryptol Reference Manual documentation master file, created by
+   sphinx-quickstart on Thu Apr 29 15:31:18 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Cryptol Reference Manual's documentation!
+====================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+Basic Syntax
+============
+
+
+Layout
+------
+
+Groups of declarations are organized based on indentation.
+Declarations with the same indentation belong to the same group.
+Lines of text that are indented more than the beginning of a
+declaration belong to that declaration, while lines of text that are
+indented less terminate a group of declarations.  Consider, for example,
+the following Cryptol declarations:
+
+.. code-block:: cryptol
+
+  f x = x + y + z
+    where
+    y = x * x
+    z = x + y
+
+  g y = y
+
+This group has two declarations, one for `f` and one for `g`.  All the
+lines between `f` and `g` that are indented more than `f` belong to
+`f`.  The same principle applies to the declarations in the ``where`` block
+of `f`, which defines two more local names, `y` and `z`.
+
+
+
+Comments
+--------
+
+Cryptol supports block comments, which start with ``/*`` and end with
+``*/``, and line comments, which start with ``//`` and terminate at the
+end of the line.  Block comments may be nested arbitrarily.
+
+.. code-block:: cryptol
+
+  /* This is a block comment */
+  // This is a line comment
+  /* This is a /* Nested */ block comment */
+
+.. todo::
+  Document ``/** */``
+
+
+Identifiers
+-----------
+
+Cryptol identifiers consist of one or more characters.  The first
+character must be either an English letter or underscore (``_``).  The
+following characters may be an English letter, a decimal digit,
+underscore (``_``), or a prime (``'``).  Some identifiers have special
+meaning in the language, so they may not be used in programmer-defined
+names (see [Keywords](#keywords-and-built-in-operators)).
+
+.. code-block:: cryptol
+
+    name    name1    name'    longer_name
+    Name    Name2    Name''   longerName
+
+
+
+Keywords and Built-in Operators
+-------------------------------
+
+The following identifiers have special meanings in Cryptol, and may
+not be used for programmer defined names:
+
+.. The table below can be generated by running `chop.hs` on this list:
+  else
+  extern
+  if
+  private
+  include
+  module
+  newtype
+  pragma
+  property
+  then
+  type
+  where
+  let
+  import
+  as
+  hiding
+  infixl
+  infixr
+  infix
+  primitive
+  parameter
+  constraint
+
+.. code-block:: cryptol
+
+        else       include    property    let       infixl       parameter
+        extern     module     then        import    infixr       constraint
+        if         newtype    type        as        infix
+        private    pragma     where       hiding    primitive
+
+
+The following table contains Cryptol's operators and their
+associativity with lowest precedence operators first, and highest
+precedence last.
+
+Operator                                   Associativity
+-----------------------------------------  -------------
+  `==>`                                    right
+  `\/`                                     right
+  `/\`                                     right
+  `==` `!=` `===` `!==`                    not associative
+  `>` `<` `<=` `>=` `<$` `>$` `<=$` `>=$`  not associative
+  `||`                                     right
+  `^`                                      left
+  `&&`                                     right
+  `#`                                      right
+  `>>` `<<` `>>>` `<<<` `>>$`              left
+  `+` `-`                                  left
+  `*` `/` `%` `/$` `%$`                    left
+  `^^`                                     right
+  `@`  `@@`  `!` `!!`                      left
+  (unary) `-` `~`                          right
+
+Table: Operator precedences.
+
+

docs/RefMan/conf.py

@@ -0,0 +1,184 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Cryptol'
+copyright = '2021, The Cryptol Team'
+author = 'The Cryptol Team'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '2.11.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.todo',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.githubpages',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'RefMan'
+
+# 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 = None
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'CryptolReferenceManualdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'CryptolReferenceManual.tex', 'Cryptol Documentation',
+     'The Cryptol Team', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'cryptolreferencemanual', 'Cryptol Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'CryptolReferenceManual', 'Cryptol Documentation',
+     author, 'CryptolReferenceManual', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True

docs/RefMan/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd