This is the documentation for Open Dylan.
It is built using Sphinx. All content is written using ReStructured Text with Sphinx extensions.
Before building this documentation, you will need a copy of Sphinx installed.
The easiest way to do this is to get it from the Python Package Index or to use
sudo easy_install -U Sphinx
You will also need to have the git submodule for our Sphinx extension populated. If this is not present for you, try doing this at the top level of the opendylan repository:
git submodule init && git submodule update
Building the documentation is easy on a system with
If you are on Windows, there is a
make.bat as well:
The generated documentation will be in
build/html. Just viewing
the HTML locally may not correctly load the CSS files. A workaround
is to cd into
build/html and run a web server. For example (python 2):
python -m SimpleHTTPServer
or (python 3):
python -m http.server
The pages can then be accessed via:
You can build other formats as well. Run
arguments to see which formats are available.
Sphinx also makes it easy to check that all of the links to external sites are valid. You can run the link checker by:
Section Header Markup
We are following the Sphinx suggestions for header markup, which are as follows:
- # with overline, for parts
- * with overline, for chapters
- =, for sections
- -, for subsections
- ^, for subsubsections
- ", for paragraphs
Note that most files will correspond to a chapter and hence will start with "*". By convention we use over and under markup at this level.
Dylan Language Markup
We have created a Dylan language Sphinx domain to make it easier to document and refer to Dylan language entities. This domain is documented in the "sphinxcontrib/dylan/domain/reference.rst" file in the "sphinx-extensions" repository.