adf860ea40
- Provides a toplevel documentation structure using Sphinx - Adds a `doc-html` target to the main Makefile - Converts existing documentation to RST format - Add some new documentation / tutorials - Links the developer manual and OCaml documentation - Synchronized documentation on Gitlab pages This patch is co-authored by: - Benjamin Canou <benjamin@canou.fr> - Bruno Bernardo <bernardobruno@gmail.com> - Pietro Abate <pietro.abate@inria.fr>
54 lines
1020 B
ReStructuredText
54 lines
1020 B
ReStructuredText
.. Tezos documentation master file, created by
|
|
sphinx-quickstart on Sat Nov 11 11:08:48 2017.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Welcome to Tezos's documentation!
|
|
=================================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Introduction:
|
|
|
|
introduction/readme
|
|
introduction/contributing
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: The Alphanet:
|
|
|
|
introduction/alphanet
|
|
introduction/alphanet_changes
|
|
introduction/zeronet
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: White doc:
|
|
|
|
whitedoc/the_big_picture
|
|
whitedoc/michelson
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Tutorials:
|
|
|
|
tutorials/data_encoding
|
|
tutorials/error_monad
|
|
tutorials/michelson_anti_patterns
|
|
tutorials/entering_alpha
|
|
tutorials/protocol_environment
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: OCaml API:
|
|
|
|
README
|
|
api/api-inline
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|