More work on ToC

metaborg · Feb 29, 2016 · 17d73cb · 17d73cb
1 parent db7b53b
commit 17d73cb
Show file tree

Hide file tree

Showing 43 changed files with 166 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -1,15 +1,20 @@
-# Spoofax documentation
+# Spoofax Documentation
 
-This repository contains Spoofax documentation made with [Sphinx](http://www.sphinx-doc.org/en/stable/).
+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.
 
 ## Building
 
 To build the documentation, use the Makefile:
 
 ```
-make html
+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.
+
+## Requirements
+
 Sphinx requires Python, at least version 2.6. To install the required Python packages, run:
 
 ```

diff --git a/index.rst b/index.rst
@@ -2,46 +2,62 @@
 Spoofax documentation
 =====================
 
+Table of Contents
+=================
+
 .. toctree::
-   :maxdepth: 2
-   :caption: Getting Started
+   :maxdepth: 3
 
-   Language Development <source/start/langdev.md>
-   Core API <source/start/core.md>
+   source/introduction
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Overview
 
-   source/overview/architecture.md
-   source/overview/glossary.md
+   source/overview/architecture
+   source/overview/glossary
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Language Development
 
-   Guides <source/langdev/guide/index.rst>
-   Manual <source/langdev/manual/index.rst>
-   Examples <source/langdev/example/index.rst>
+   Getting Started <source/langdev/start>
+   Guides <source/langdev/guide/index>
+   Manual <source/langdev/manual/index>
+   Meta-Languages <source/langdev/meta/lang/index>
+   Meta-Libraries <source/langdev/meta/lib/index>
+   Examples <source/langdev/example/index>
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Core API
 
-   Guides <source/core/guide/index.rst>
-   Manual <source/core/manual/index.rst>
-   Examples <source/core/example/index.rst>
+   Getting Started <source/core/start>
+   Guides <source/core/guide/index>
+   Manual <source/core/manual/index>
+   Examples <source/core/example/index>
+   API Reference <source/core/api>
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Notes
-
-   notes/audience.md
-   notes/outline.md
+   :maxdepth: 3
+   :caption: Spoofax Development
 
+   Build <source/dev/build>
+   Bootstrap <source/dev/bootstrap>
+   Release <source/dev/release>
+   Contribute <source/dev/contribute>
 
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`
+.. toctree::
+   :maxdepth: 3
+   :caption: Releases
+
+   source/release/note/index
+   source/release/migrate/index
+
+.. .. toctree::
+..    :maxdepth: 3
+..    :caption: Notes
+..    :hidden:
+..
+..    notes/audience
+..    notes/outline
diff --git a/notes/outline.md b/notes/outline.md
@@ -80,7 +80,7 @@
 * Core API
   * Guides
   * Manual
-    * Project structure
+    * Components
       * MetaBorg vs Spoofax
       * Language runtime vs language development runtime (meta)
     * Facades

diff --git a/source/core/api.md b/source/core/api.md
@@ -0,0 +1 @@
+# API Reference
diff --git a/source/core/guide/artifact.md b/source/core/guide/artifact.md
@@ -0,0 +1,7 @@
+# Using Core API Artifacts
+
+## With Maven
+
+## With Gradle
+
+## Downloading JARs
diff --git a/source/core/guide/index.rst b/source/core/guide/index.rst
@@ -3,4 +3,6 @@ Core API Guides
 ===============
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
+
+   artifact
diff --git a/source/core/manual/component.md b/source/core/manual/component.md
@@ -0,0 +1 @@
+# Components
diff --git a/source/core/manual/facade.md b/source/core/manual/facade.md
@@ -0,0 +1 @@
+# Facades
diff --git a/source/core/manual/high-service.md b/source/core/manual/high-service.md
@@ -0,0 +1 @@
+# High-Level Services
diff --git a/source/core/manual/index.rst b/source/core/manual/index.rst
@@ -4,3 +4,7 @@ Core API Manual
 
 .. toctree::
    :maxdepth: 1
+
+   component
+   facade
+   high-service
diff --git a/source/start/core.md → source/core/start.md b/source/start/core.md → source/core/start.md
diff --git a/source/dev/bootstrap.md b/source/dev/bootstrap.md
@@ -0,0 +1 @@
+# Bootstrapping Spoofax
diff --git a/source/dev/build.md b/source/dev/build.md
@@ -0,0 +1 @@
+# Building Spoofax
diff --git a/source/dev/contribute.md b/source/dev/contribute.md
@@ -0,0 +1 @@
+# Contributing to Spoofax
diff --git a/source/dev/release.md b/source/dev/release.md
@@ -0,0 +1 @@
+# Releasing Spoofax
diff --git a/source/introduction.md b/source/introduction.md
@@ -0,0 +1,7 @@
+# Introduction
+
+## Description
+
+## License
+
+## Structure of the Documentation
diff --git a/source/langdev/guide/build.md b/source/langdev/guide/build.md
@@ -1 +1,5 @@
 # Building and Continuous Integration
+
+## With Maven
+
+## With Gradle
diff --git a/source/langdev/guide/export.md b/source/langdev/guide/export.md
@@ -1 +1,9 @@
-# Exporting a Language
+# Exporting and Using a Language
+
+## As an Eclipse plugin
+
+## As an IntelliJ plugin
+
+## As custom library/application using the core API
+
+## With Sunshine
diff --git a/source/langdev/guide/index.rst b/source/langdev/guide/index.rst
@@ -5,6 +5,6 @@ Language Development Guides
 .. toctree::
    :maxdepth: 1
 
-   declare.md
-   export.md
-   build.md
+   declare
+   export
+   build
diff --git a/source/langdev/manual/configuration.md b/source/langdev/manual/configuration.md
@@ -0,0 +1 @@
+# Configuration
diff --git a/source/langdev/manual/env/eclipse.md b/source/langdev/manual/env/eclipse.md
@@ -0,0 +1 @@
+# Eclipse Environment
diff --git a/source/langdev/manual/env/intellij.md b/source/langdev/manual/env/intellij.md
@@ -0,0 +1 @@
+# IntelliJ Environment
diff --git a/source/langdev/manual/index.rst b/source/langdev/manual/index.rst
@@ -3,4 +3,9 @@ Language Development Manual
 ===========================
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
+
+   env/eclipse
+   env/intellij
+   project
+   configuration
diff --git a/source/langdev/manual/project.md b/source/langdev/manual/project.md
@@ -0,0 +1 @@
+# Project Structure
diff --git a/source/langdev/meta/lang/dynsem.md b/source/langdev/meta/lang/dynsem.md
@@ -0,0 +1 @@
+# DynSem
diff --git a/source/langdev/meta/lang/esv.md b/source/langdev/meta/lang/esv.md
@@ -0,0 +1 @@
+# ESV
diff --git a/source/langdev/meta/lang/index.rst b/source/langdev/meta/lang/index.rst
@@ -0,0 +1,15 @@
+=====================
+Meta Languages Manual
+=====================
+
+.. toctree::
+   :maxdepth: 2
+
+   esv
+   sdf3
+   stratego
+   nabl
+   ts
+   nabl2
+   dynsem
+   spt
diff --git a/source/langdev/meta/lang/nabl.md b/source/langdev/meta/lang/nabl.md
@@ -0,0 +1 @@
+# NaBL
diff --git a/source/langdev/meta/lang/nabl2.md b/source/langdev/meta/lang/nabl2.md
@@ -0,0 +1 @@
+# NaBL2
diff --git a/source/langdev/meta/lang/sdf3.md b/source/langdev/meta/lang/sdf3.md
@@ -0,0 +1 @@
+# SDF3
diff --git a/source/langdev/meta/lang/spt.md b/source/langdev/meta/lang/spt.md
@@ -0,0 +1 @@
+# SPT
diff --git a/source/langdev/meta/lang/stratego.md b/source/langdev/meta/lang/stratego.md
@@ -0,0 +1 @@
+# Stratego
diff --git a/source/langdev/meta/lang/ts.md b/source/langdev/meta/lang/ts.md
@@ -0,0 +1 @@
+# TS
diff --git a/source/langdev/meta/lib/analysis.md b/source/langdev/meta/lib/analysis.md
@@ -0,0 +1 @@
+# Analysis Library
diff --git a/source/langdev/meta/lib/analysis2.md b/source/langdev/meta/lib/analysis2.md
@@ -0,0 +1 @@
+# Analysis Library 2
diff --git a/source/langdev/meta/lib/index.rst b/source/langdev/meta/lib/index.rst
@@ -0,0 +1,9 @@
+=====================
+Meta Libraries Manual
+=====================
+
+.. toctree::
+   :maxdepth: 2
+
+   analysis
+   analysis2
diff --git a/source/start/langdev.md → source/langdev/start.md b/source/start/langdev.md → source/langdev/start.md
diff --git a/source/release/migrate/2.0.0.md b/source/release/migrate/2.0.0.md
@@ -0,0 +1 @@
+# Spoofax 2.0.0 Migration
diff --git a/source/release/migrate/index.rst b/source/release/migrate/index.rst
@@ -0,0 +1,8 @@
+================
+Migration Guides
+================
+
+.. toctree::
+   :maxdepth: 2
+
+   2.0.0 <2.0.0>
diff --git a/source/release/note/2.0.0.md b/source/release/note/2.0.0.md
@@ -0,0 +1 @@
+# Spoofax 2.0.0
diff --git a/source/release/note/index.rst b/source/release/note/index.rst
@@ -0,0 +1,8 @@
+=============
+Release Notes
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   2.0.0 <2.0.0>
diff --git a/source/release/notes/2.0.0.md b/source/release/notes/2.0.0.md
@@ -0,0 +1 @@
+# Spoofax 2.0.0
diff --git a/source/release/notes/index.rst b/source/release/notes/index.rst
@@ -0,0 +1,8 @@
+=============
+Release Notes
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   2.0.0 <2.0.0>