Documentation fixes

librecores · Sep 9, 2017 · 74cd227 · 74cd227
1 parent 5fca8ed
commit 74cd227
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 19 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -1,27 +1,27 @@
 API Documentation
 =================
 
-Configuration
--------------
+``lcci.configuration``
+----------------------
 
 .. automodule:: lcci.configuration
     :members:
     :undoc-members:
     :show-inheritance:
 
 
-Tools
------
+``lcci.tools``
+--------------
 
 .. automodule:: lcci.tools
     :members:
     :undoc-members:
     :show-inheritance:
 
-Agents
------
+``lcci.agent``
+--------------
 
-    .. automodule:: lcci.agents
-        :members:
-        :undoc-members:
-        :show-inheritance:
+.. automodule:: lcci.agent
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,23 +3,42 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to LibreCores CI Tool's documentation!
-==============================================
+LibreCores CI Tool
+==================
+
+Welcome to the LibreCores CI tool (``lcci``).
+This tool is used to setup and control agents connected to the LibreCores Continuous Integration (CI) infrastructure.
+Agents can be set up and connected to run jobs for either your own projects, any other project or with projects matching certain criteria.
+
+To ensure agents share a common setup and to guarantee reproducible builds we use `Environment Modules <http://modules.sourceforge.net>`_.
+Tools can be installed in different versions and the build environment selects the proper version.
+We provide a set of `Docker <http://docker.com>`_ containers to automatically build and/or install the tools.
+Along with the tool itself the configuration files for Environment Modules are created (so called ``modulefiles``).
+
+In the projects' ``Jenkinsfile`` the modules are then accordingly loaded:
+
+.. code-block:: groovy
+
+   node('lcci-2017.1') {
+      lcci.load(["eda/fusesoc/1.6.1",
+                 "eda/verilator/3.902"])
 
-Contents:
+      ...
+   }
+
+
+Contents
+--------
 
 .. toctree::
    :maxdepth: 2
 
-   configuration
-   tools
-   agent
-
+   gettingstarted
+   api
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-