Skip to content

Commit

Permalink
Fix readme, add working pages to index
Browse files Browse the repository at this point in the history
  • Loading branch information
Gohla committed Mar 2, 2016
1 parent 0ffcce6 commit 8020686
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

This repository contains the Spoofax documentation, made with [Sphinx](http://www.sphinx-doc.org/en/stable/) in the [Read The Docs](https://docs.readthedocs.org/en/latest/index.html) style of documentation.

This documentation is hosted at http://spoofax.readthedocs.org/.
When a commit to this repository is made, it will automatically [build and update](http://readthedocs.org/projects/spoofax/builds/) the documentation.

## Building

To build the documentation, use the Makefile:
Expand All @@ -11,7 +14,7 @@ make clean html
```

which will generate HTML documentation into `_build/html` with `_build/html/index.html` as the main page.
Use the `latexpdf` target to build a PDF version of the documentation, and `epub` for an e-book (book format with) build.
Use the `latexpdf` target to build a PDF version of the documentation, and `epub` for an e-book (book format with resizable text, for tablets and e-readers) build.

## Requirements

Expand Down
3 changes: 2 additions & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Spoofax is a framework for developing textual software languages with full-featu

The Spoofax documentation is a work in progress. Most pages in the table of contents below are empty or just contain headers. The following pages currently contain useful content:


- :doc:`source/release/note/2.0.0`
- :doc:`source/release/migrate/2.0.0`

Table of Contents
=================
Expand Down

0 comments on commit 8020686

Please sign in to comment.