mirror of
https://github.com/digital-asset/daml.git
synced 2024-09-20 09:17:43 +03:00
d3dad75d00
Adding `Daml Documentation >> Building applications >> "Self-Service Error Codes (Experimental)` section in the HTML documentation. The section is populated automatically with error code information retrieved from the classpath. The process of generating documentation for error codes looks like this: - first we find error codes information from the classpath, - then we save it to a json file, - then the json file is made available to a custom Sphinx extension, - then the custom Sphinx extension generates documentation wherever we put a new custom Sphinx directive. Try it out with `./docs/scripts/live-preview.sh` or `./docs/scripts/preview.sh` CHANGELOG_BEGIN CHANGELOG_END
132 lines
2.3 KiB
ReStructuredText
132 lines
2.3 KiB
ReStructuredText
.. Copyright (c) 2021 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
|
|
.. SPDX-License-Identifier: Apache-2.0
|
|
|
|
Daml Documentation
|
|
##################
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
:maxdepth: 2
|
|
:hidden:
|
|
|
|
self
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
:maxdepth: 2
|
|
:hidden:
|
|
:caption: Getting started
|
|
|
|
Installing the SDK <getting-started/installation>
|
|
Building Your App <getting-started/index>
|
|
getting-started/app-architecture
|
|
getting-started/first-feature
|
|
Cheat Sheet <https://docs.daml.com/cheat-sheet>
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
:maxdepth: 2
|
|
:hidden:
|
|
:caption: Writing Daml
|
|
|
|
daml/intro/0_Intro.rst
|
|
daml/reference/index
|
|
daml/stdlib/index
|
|
daml/troubleshooting
|
|
/daml/patterns
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
:maxdepth: 2
|
|
:hidden:
|
|
:caption: Building applications
|
|
|
|
app-dev/app-arch
|
|
app-dev/bindings-ts/index
|
|
json-api/index
|
|
Daml Script <daml-script/index>
|
|
Daml REPL <daml-repl/index>
|
|
upgrade/index
|
|
app-dev/authorization
|
|
app-dev/ledger-api
|
|
triggers/index
|
|
tools/trigger-service/index
|
|
tools/auth-middleware/index
|
|
error-codes/self-service/index
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
:maxdepth: 2
|
|
:hidden:
|
|
:caption: Deploying to Daml ledgers
|
|
|
|
deploy/index
|
|
deploy/generic_ledger
|
|
deploy/ledger-topologies
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
:maxdepth: 2
|
|
:hidden:
|
|
:caption: Operating Daml
|
|
|
|
ops/index
|
|
ops/connect/index
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
:maxdepth: 2
|
|
:hidden:
|
|
:caption: Developer Tools
|
|
|
|
tools/assistant
|
|
daml/daml-studio
|
|
tools/sandbox
|
|
tools/navigator/index
|
|
tools/codegen
|
|
tools/profiler
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
:maxdepth: 2
|
|
:hidden:
|
|
:caption: Background concepts
|
|
|
|
concepts/glossary
|
|
concepts/ledger-model/index
|
|
concepts/identity-and-package-management
|
|
concepts/time
|
|
concepts/local-ledger
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
:maxdepth: 2
|
|
:hidden:
|
|
:caption: Examples
|
|
|
|
Examples <https://daml.com/examples>
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
:maxdepth: 2
|
|
:hidden:
|
|
:caption: Early Access Features
|
|
|
|
tools/extractor
|
|
tools/export/index
|
|
daml-integration-kit/index
|
|
tools/visual
|
|
concepts/interoperability
|
|
tools/non-repudiation
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
:maxdepth: 2
|
|
:hidden:
|
|
:caption: Daml Ecosystem
|
|
|
|
support/overview
|
|
support/releases
|
|
support/compatibility
|
|
support/support
|