From edf87f09045e8f56576b37078b4a0d220d6ddf55 Mon Sep 17 00:00:00 2001 From: Melody Horn Date: Wed, 28 Oct 2020 17:01:55 -0600 Subject: start using Sphinx for doc generation --- index.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 index.rst (limited to 'index.rst') diff --git a/index.rst b/index.rst new file mode 100644 index 0000000..c3fa323 --- /dev/null +++ b/index.rst @@ -0,0 +1,30 @@ +.. Crowbar spec documentation master file, created by + sphinx-quickstart on Wed Oct 28 15:04:27 2020. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. include:: README.md + +Crowbar Specification +===================== + +Version |version| + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + intro + vs-c + tagged-unions + types + safety + errors + syntax + LICENSE + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` -- cgit v1.2.3