Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
_static Import wiki contents to a sphinx-doc website (#827) Nov 23, 2019
_templates
discussions Fix typo in title of "Safety guarantees" page (#889) Jan 22, 2020
howtos
references Add support for hexadecimal numbers (#859) Dec 22, 2019
tutorials
README
conf.py Import wiki contents to a sphinx-doc website (#827) Nov 23, 2019
index.md Clarify "Edit me" message on docs site (#853) Dec 19, 2019

README

The source code for docs.dhall-lang.org
=======================================

# Build

To build the website:

```bash
$ nix build --file ./release.nix docs
```

Then open `result/index.html`

# Contribute

Markdown references: https://commonmark.org/help/

# References

Sphinx configuration `conf.py` file documentation: https://www.sphinx-doc.org/en/master/usage/configuration.html

Recommonmark config: https://recommonmark.readthedocs.io/en/latest/auto_structify.html

Pygments lexer doc: https://pygments.org/docs/lexerdevelopment.html

# Migration notes

When importing current wiki content, here are some thing to remember:

* Add '# doc-title' at the top
* For the Dhall-in-production and built-in-types documents, shift sections by replacing '^#' -> '^##'
* Remove backtic in built-in-types type heading: '^## `\(.*\)`' -> '## \1'
* Replace ':' with '_' in filename
You can’t perform that action at this time.