diff options
| author | Melody Horn <melody@boringcactus.com> | 2020-10-28 17:01:55 -0600 |
|---|---|---|
| committer | Melody Horn <melody@boringcactus.com> | 2020-10-28 17:01:55 -0600 |
| commit | edf87f09045e8f56576b37078b4a0d220d6ddf55 (patch) | |
| tree | 4503afb80ee7ea068db257c6381541a5fe1f716b /index.rst | |
| parent | 72e8cabe8e3c8ae272fb4771f0d1dabb306dc2ae (diff) | |
| download | spec-edf87f09045e8f56576b37078b4a0d220d6ddf55.tar.gz spec-edf87f09045e8f56576b37078b4a0d220d6ddf55.zip | |
start using Sphinx for doc generation
Diffstat (limited to 'index.rst')
| -rw-r--r-- | index.rst | 30 |
1 files changed, 30 insertions, 0 deletions
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` |