Modification to docs

2 files changed, 25 insertions, 8 deletions

diff --git a/doc/source/createproject.rst b/doc/source/createproject.rst
index d68b02511..f6d34472d 100644
--- a/doc/source/createproject.rst
+++ b/doc/source/createproject.rst
@@ -49,10 +49,11 @@ Project.conf
 
 In the root of the project directory create a file called project.conf containing::
 
-  name: Tim
-  element-path: elements
+  name: ProjectName  #The name you want to give to your project
+  element-path: elementsPath #The path to the "elements" directory
   aliases:
-    gnomesdk: https://sdk.gnome.org/
+    name:url #This is used so you can moderate the URLs/Repos used by your build. 
+             #This way, they can be modified in a single place instead of multiple
 
 step7.bst
 ~~~~
@@ -73,6 +74,14 @@ In the elements directory Create a file called step7.bst containing::
       url: file:/src/step7.tar.gz
       ref: 9591707afbae77751730b4af4c52a18b1cdc4378237bc64055f099bc95c330db
   
+:ref:`format_kind`
+
+:ref:`format_depends`
+
+:ref:`format_sources`
+
+.. this is done until i can find a better way of incorperating hyperlinks into sourcecode blocks
+
 base-sdk.bst
 ~~~~
 
@@ -90,6 +99,8 @@ In the elements/dependencies directory Create a file called base-sdk.bst contain
     source: files
     target: usr
 
+:ref:`format_config`
+
 base-platform.bst
 ~~~~
 
@@ -109,13 +120,13 @@ In the elements/dependencies directory Create a file called base-platform.bst co
     bst:
       integration-commands:
       - ldconfig
- 
+
+:ref:`format_public` 
+
 Building
 ----
 
-From the project root directory run::
-
-  bst build step7.bst
+From the project root directory run:
 
-bst :ref:`_invoking_build` step7.bst
+  ``bst`` :ref:`invoking_build` ``step7.bst``
 
diff --git a/doc/source/format.rst b/doc/source/format.rst
index 7e4638e1c..66a9d3f20 100644
--- a/doc/source/format.rst
+++ b/doc/source/format.rst
@@ -53,6 +53,7 @@ details here in order to have a more complete initial example.
 
 Let's break down the above and give a brief explanation of what these attributes mean.
 
+.. _format_kind:
 
 Kind
 ~~~~
@@ -72,6 +73,7 @@ To refer to a third party plugin, prefix the plugin with its package, for exampl
 
    kind: buildstream-plugins:dpkg_build
 
+.. _format_depends:
 
 Depends
 ~~~~~~~
@@ -88,6 +90,7 @@ definitions may depend on other elements by specifying the project relative path
 to the elements on which they depend here. See `Dependencies`_ for more information
 on the dependency model.
 
+.. _format_sources:
 
 Sources
 ~~~~~~~
@@ -132,6 +135,7 @@ Asides from the common ``kind`` and ``directory`` attributes which may be applie
 Sources, refer to the Source specific documentation for meaningful attributes for the
 particular Source.
 
+.. _format_variables:
 
 Variables
 ~~~~~~~~~
@@ -147,6 +151,7 @@ declared and overridden in the :ref:`projectconf`
 
 See `Using Variables`_ below for a more in depth discussion on variables in BuildStream.
 
+.. _format_environment:
 
 Environment
 ~~~~~~~~~~~
@@ -164,6 +169,7 @@ build instructions are run for this element.
 
 Environment variables can also be declared and overridden in the :ref:`projectconf`
 
+.. _format_config:
 
 Config
 ~~~~~~