source: specdomain/trunk/src/specdomain/doc/howto-build.rst @ 1028

Last change on this file since 1028 was 1028, checked in by jemian, 10 years ago

refs #8: finish the documentation

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision URL Header
File size: 1.2 KB
Line 
1.. $Id: howto-build.rst 1028 2012-07-16 06:06:58Z jemian $
2
3
4====================================================================
5How to Build the Documentation from a Sphinx project
6====================================================================
7
8Briefly::
9
10        make html
11
12Load the file ``index.html`` into your browser and examine the results.
13The file path is different depending if you have an *in-source* or
14*out-of-source* configuration.
15
16
17.. index:: in-source configuration
18.. index:: out-of-source configuration
19
20*in-source* path:
21        ``_build/html/index.html``
22*out-of-source* path:
23        ``build/html/index.html``
24
25Test
26=====
27
28For our testing purposes, we'll document the *aalength.mac* 
29macro file from the :ref:`Install` section.
30Edit the new file *index.rst* and add this line at line 14. 
31Make sure it lines up at the left in column 1::
32       
33        .. autospecmacro:: ../specdomain/doc/aalength.mac
34
35Build the HTML documentation::
36
37    make html
38
39View the documentation using a web browser such as *firefox*::
40
41        firefox _build/html/index.html &
42
43You should see a page that looks like this, if nothing went wrong.
44
45.. figure:: test1.png
46    :alt: view of aalength.mac HTML documentation
47
48    Documentation of the **aalength.mac** file.
Note: See TracBrowser for help on using the repository browser.