Skip to content

Commit 4e64a00

Browse files
SimonJFSimonJF
committed
Initial structure
1 parent ef28a1b commit 4e64a00

19 files changed

+293
-2
lines changed

‎Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,14 @@
1-
# documentation
2-
In-progress Sphinx documentation for Links
1+
# Documentation
2+
3+
This repository contains the [Sphinx](http://www.sphinx-doc.org) sources for an initial attempt at proper Links documentation. It is nowhere near complete, so please bear with us, but we're actively making an effort now.
4+
5+
To build the documentation, run `make html`. The HTML sources will be output into `_build/html`. A quick way to view the docs would be
6+
```
7+
make html
8+
cd _build/html
9+
python3 -m http.server
10+
```
11+
12+
(assuming a Python 3 executable of `python3`).
13+
14+
The docs will be hosted once they are deemed stable enough.

‎conf.py

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# http://www.sphinx-doc.org/en/master/config
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
# import os
14+
# import sys
15+
# sys.path.insert(0, os.path.abspath('.'))
16+
17+
18+
# -- Project information -----------------------------------------------------
19+
20+
project = 'Links'
21+
copyright = '2019, The Links Developers'
22+
author = 'The Links Developers'
23+
24+
# The full version, including alpha/beta/rc tags
25+
release = '0.9 (Burghmuirhouse)'
26+
27+
28+
# -- General configuration ---------------------------------------------------
29+
30+
# Add any Sphinx extension module names here, as strings. They can be
31+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32+
# ones.
33+
extensions = [
34+
]
35+
36+
# Add any paths that contain templates here, relative to this directory.
37+
templates_path = ['_templates']
38+
39+
# List of patterns, relative to source directory, that match files and
40+
# directories to ignore when looking for source files.
41+
# This pattern also affects html_static_path and html_extra_path.
42+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
43+
44+
45+
# -- Options for HTML output -------------------------------------------------
46+
47+
# The theme to use for HTML and HTML Help pages. See the documentation for
48+
# a list of builtin themes.
49+
#
50+
html_theme = 'alabaster'
51+
52+
# Add any paths that contain custom static files (such as style sheets) here,
53+
# relative to this directory. They are copied after the builtin static files,
54+
# so a file named "default.css" will overwrite the builtin "default.css".
55+
html_static_path = ['_static']

‎getting-started.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Getting started
2+
===============
3+
4+
TODO: Getting started guide

‎index.rst

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
Links Documentation
3+
=================================
4+
5+
Welcome to the Links documentation!
6+
This is very much a work-in-progress, so please bear with us.
7+
8+
.. toctree::
9+
:maxdepth: 2
10+
:caption: Contents:
11+
12+
install
13+
getting-started
14+
language-ref
15+
library-ref
16+
resources
17+
18+
19+
Indices and tables
20+
==================
21+
22+
* :ref:`genindex`
23+
* :ref:`modindex`
24+
* :ref:`search`

‎install.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Installation
2+
============
3+
4+
TODO: Installation instructions

‎lang-ref/database.rst

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Database Access
2+
===============

‎lang-ref/expressions.rst

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
Expressions
2+
===========
3+
4+
Literals
5+
--------
6+
7+
Binding
8+
-------
9+
10+
Functions
11+
---------
12+
13+
TODO: Non-recursive by default, unless they refer to themselves
14+
15+
Mutually-recursive functions
16+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17+
18+
Conditional expressions
19+
-----------------------
20+
21+
Operators
22+
---------
23+
24+
Lists
25+
-----
26+
27+
Tuples
28+
------
29+
30+
Records
31+
-------
32+
33+
Record update
34+
~~~~~~~~~~~~~
35+
36+
Variants
37+
--------
38+
39+
Construction
40+
~~~~~~~~~~~~
41+
42+
Case analysis
43+
~~~~~~~~~~~~~
44+
45+
Comprehensions
46+
--------------
47+
48+
Filtering
49+
~~~~~~~~~
50+
51+
Sorting
52+
~~~~~~~
53+
54+
Multiple generators
55+
~~~~~~~~~~~~~~~~~~~

‎lang-ref/introduction.rst

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Introduction
2+
============
3+

‎lang-ref/lexical-syntax.rst

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Lexical Syntax
2+
==============
3+
4+
Identifiers
5+
-----------
6+
7+
Constructors
8+
------------
9+
10+
Comments
11+
--------
12+
13+
Operators
14+
---------
15+
16+
Keywords
17+
--------
18+

‎lang-ref/modules.rst

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Modules
2+
=======

‎lang-ref/typing.rst

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Type system
2+
===========

‎lang-ref/web.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Web Applications
2+
================
3+
4+
TODO

‎language-ref.rst

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Language Reference
2+
==================
3+
4+
This manual informally describes the syntax and type system of Links.
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
:caption: Contents:
9+
10+
lang-ref/introduction.rst
11+
lang-ref/lexical-syntax.rst
12+
lang-ref/expressions.rst
13+
lang-ref/modules.rst
14+
lang-ref/database.rst
15+
lang-ref/web.rst
16+
lang-ref/typing.rst

‎library-docs/mvu.rst

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Mvu
2+
===
3+
4+
The ``Mvu`` file is the entrypoint for applications using the Model-View-Update architecture.
5+
6+
TODO: Document more

‎library-docs/prelude.rst

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Prelude
2+
=======
3+
4+
The Prelude contains basic Links functions and data structures, and is loaded by default for every file.
5+
6+
TODO: Document Prelude

‎library-ref.rst

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Library Reference
2+
=================
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
:caption: Library Documentation:
7+
8+
library-docs/prelude
9+
library-docs/mvu
10+

‎make.bat

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎resources.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Resources
2+
=========
3+
4+
Example Links Projects
5+
----------------------
6+
7+
Papers
8+
------
9+
10+
Dissertations and theses
11+
------------------------
12+
13+

0 commit comments

Comments
 (0)