docs: move cheatsheet

CHANGELOG.md

@@ -7,7 +7,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ## [Unpublished yet]
 
 ### API
-* (breaking) MR ??: `model_expand` API is now a regular function, not an iterator
+* (breaking) MR 193: `model_expand` API is now a regular function, not an iterator
 * fix #163: improve performance by avoiding unnecessary copying
 * MR !181: support Python 3.10
 * MR !188: print models in uniform format to structure

docs/FO-dot.rst

@@ -10,8 +10,7 @@ Overview
 --------
 
 The FO(:raw-html:`&#183`) (aka FO-dot) language is used to create knowledge bases.
-An IDP-Z3 program contains an FO(:raw-html:`&#183`) knowledge base and instructions to perform tasks on it.
-It is made of the following blocks of code:
+An FO-dot knowledge base is a text file containing the following blocks of code:
 
 vocabulary
     specify the types, predicates, functions and constants used to describe the problem domain.
@@ -47,4 +46,3 @@ Everything between ``//`` and the end of the line is a comment.
 .. include:: IDPLanguage/theory.inc
 .. include:: IDPLanguage/structure.inc
 .. include:: IDPLanguage/IDP3.inc
-.. include:: IDPLanguage/summary.inc

docs/IDPLanguage/IDP3.inc

@@ -3,7 +3,7 @@
 Differences with IDP3
 ---------------------
 
-Here are the main differences with IDP3, listed for migration purposes:
+Here are the main differences with IDP3 (the previous version of IDP-Z3), listed for migration purposes:
 
 Infinite domains
     IDP-Z3 supports infinite domains: ``Int, Real``.
@@ -23,9 +23,6 @@ Partial functions
     The handling of division by 0 may differ.
     See `IEP 07 <https://gitlab.com/krr/IDP-Z3/-/wikis/IEP-07-Division-by-0>`_
 
-Programming API
-    IDP3 procedures are written in Lua, IDP-Z3 procedures are written in Python-like language.
-
 Qualified quantifications
     IDP-Z3 does not support qualified quantifications, e.g. ``!2 x[color]: p(x).``. (p. 11 of the IDP3 manual).
 

docs/conf.py

@@ -65,3 +65,5 @@ autodoc_default_options = {
     'member-order': 'bysource',
     'special-members': '__init__',
 }
+add_module_names = False
+autodoc_typehints = "description"
\ No newline at end of file

docs/index.rst

@@ -15,6 +15,7 @@ Welcome to IDP-Z3's documentation!
    IDP-Z3
    interactive_consultant
    code_reference
+   summary
    genindex
 
 

docs/IDPLanguage/summary.inc → docs/summary.rst

 
 
-Syntax summary
---------------
+Appendix: Syntax summary
+========================
 
 The following code illustrates the syntax of IDP-Z3.
 T denotes a type, c a constructor, p a proposition or predicate, f a constant or function.