@@ -28,11 +28,11 @@ test software projects hosted at *GitHub* (both on our public and IBM enterprise
28
28
29
29
# Table of Contents
30
30
31
- 1 . [ Documenting the Organization] ( documenting-the-organization )
32
- 1.1 [ HowTo - Automated documentation compilation ] ( howto-automated-documentation-compilation )
33
- 1.2 [ HowTo - Manual documentation compilation ] ( howto-manual-documentation-compilation )
34
- 2 . [ Documenting the cF Repositories] ( )
35
- 3 . [ Documenting the cF Source Codes] ( documenting-the-cf-source-codes )
31
+ 1 . [ Documenting the Organization] ( #1- documenting-the-organization)
32
+ 1.1 [ How to automatically compile the documentation ] ( #11-how-to-automatically-compile-the-documentation )
33
+ 1.2 [ How to manually compile the documentation ] ( #12-how-to-manually-compile-the-documentation )
34
+ 2 . [ Documenting the cF Repositories] ( #2-documenting-the-cf-repositories )
35
+ 3 . [ Documenting the cF Source Codes] ( #3- documenting-the-cf-source-codes)
36
36
37
37
## 1. Documenting the Organization
38
38
@@ -48,7 +48,7 @@ of the *GitHub* pages. However, if you need to re-build and update this document
48
48
please follow the step-by-step procedure in the
49
49
[ Manual documentation compilation] ( #howto-manual-documentation-compilation ) section.
50
50
51
- ### 1.1 HowTo - Automated documentation compilation
51
+ ### 1.1 How to automatically compile the documentation
52
52
53
53
As mentioned above, an new compilation of the overall cloudFPGA documentation is triggered
54
54
whenever a commit to this current [ Doc] ( https://github.com/cloudFPGA/Doc ) repository occurs.
@@ -61,12 +61,12 @@ and also bypass [jekyll](https://jekyllrb.com/) processing of `GitHub Pages` by
61
61
file named ` .nojekyll ` on the repository. Eventually the final documentation is available
62
62
[ here] ( https://pages.github.ibm.com/cloudFPGA/Doc/ ) .
63
63
64
- ### 1.2 HowTo - Manual documentation compilation
64
+ ### 1.2 How to manually compile the documentation
65
65
66
66
If you need to manually compile the overall cloudFPGA documentation on your local development
67
67
environment, please follow these steps:
68
68
69
- #### 1.2.1 Step 1/3: Sphinx and dependencies setup
69
+ #### 1.2.1 Sphinx and dependencies setup (Step 1/3)
70
70
71
71
To generate the Sphinx based python documentations, you need to setup:
72
72
``` bash
77
77
pip install -r ./cloudFPGA-Doc/docsrc/requirements.txt
78
78
79
79
```
80
- #### 1.2.2 Step 2/3: Rebuild Documentation
80
+ #### 1.2.2 Rebuild documentation ( Step 2/3)
81
81
82
82
``` bash
83
83
. sphinx/bin/activate
@@ -89,7 +89,7 @@ make localhtml
89
89
firefox _build/html/index.html & (to view your changes locally)
90
90
```
91
91
92
- #### 1.2.3 Step 3/3: Update Documentation
92
+ #### 1.2.3 Update documentation ( Step 3/3)
93
93
94
94
```
95
95
git checkout gh-pages (ensure you are on this branch)
@@ -115,14 +115,14 @@ The following cF repositories are currently parsed for `Markdown` files:
115
115
changes directly on the ` Markdown ` files in those repositories. Next, to make the changes being reflected
116
116
onto the HTML pages, you can use the following automated or manual procedure.
117
117
118
- ### 2.1 HowTo - Automated update of a cF repository documentation
118
+ ### 2.1 Automated update of a cF repository documentation
119
119
120
120
Force a [ Restart Build] ( https://travis.ibm.com/cloudFPGA/Doc ) job on the Travis CI page.
121
121
This is useful when you don't have any changes for the current
122
122
[ Organization Documentation] ( #documenting-the-organization )
123
123
but you want update the documentation of a [ specific cF repository] ( #documenting-the-cf-repositories ) .
124
124
125
- ### 2.2 HowTo - Manual update of a cF repository documentation
125
+ ### 2.2 Manual update of a cF repository documentation
126
126
127
127
Clone the [ Doc] ( https://github.com/cloudFPGA/Doc ) repo, create a minor commit and push it.
128
128
This is useful when you made changes in both the [ Organization Documentation] ( #documenting-the-organization )
0 commit comments