Skip to content

Commit ad87cfc

Browse files
committed
Fixes internal links
1 parent c72e41f commit ad87cfc

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ test software projects hosted at *GitHub* (both on our public and IBM enterprise
2828

2929
# Table of Contents
3030

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)
3636

3737
## 1. Documenting the Organization
3838

@@ -48,7 +48,7 @@ of the *GitHub* pages. However, if you need to re-build and update this document
4848
please follow the step-by-step procedure in the
4949
[Manual documentation compilation](#howto-manual-documentation-compilation) section.
5050

51-
### 1.1 HowTo - Automated documentation compilation
51+
### 1.1 How to automatically compile the documentation
5252

5353
As mentioned above, an new compilation of the overall cloudFPGA documentation is triggered
5454
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
6161
file named `.nojekyll` on the repository. Eventually the final documentation is available
6262
[here](https://pages.github.ibm.com/cloudFPGA/Doc/).
6363

64-
### 1.2 HowTo - Manual documentation compilation
64+
### 1.2 How to manually compile the documentation
6565

6666
If you need to manually compile the overall cloudFPGA documentation on your local development
6767
environment, please follow these steps:
6868

69-
#### 1.2.1 Step 1/3: Sphinx and dependencies setup
69+
#### 1.2.1 Sphinx and dependencies setup (Step 1/3)
7070

7171
To generate the Sphinx based python documentations, you need to setup:
7272
```bash
@@ -77,7 +77,7 @@ git clone [email protected]:cloudFPGA/Doc.git cloudFPGA-Doc
7777
pip install -r ./cloudFPGA-Doc/docsrc/requirements.txt
7878

7979
```
80-
#### 1.2.2 Step 2/3: Rebuild Documentation
80+
#### 1.2.2 Rebuild documentation (Step 2/3)
8181

8282
```bash
8383
. sphinx/bin/activate
@@ -89,7 +89,7 @@ make localhtml
8989
firefox _build/html/index.html & (to view your changes locally)
9090
```
9191

92-
#### 1.2.3 Step 3/3: Update Documentation
92+
#### 1.2.3 Update documentation (Step 3/3)
9393

9494
```
9595
git checkout gh-pages (ensure you are on this branch)
@@ -115,14 +115,14 @@ The following cF repositories are currently parsed for `Markdown` files:
115115
changes directly on the `Markdown` files in those repositories. Next, to make the changes being reflected
116116
onto the HTML pages, you can use the following automated or manual procedure.
117117

118-
### 2.1 HowTo - Automated update of a cF repository documentation
118+
### 2.1 Automated update of a cF repository documentation
119119

120120
Force a [Restart Build](https://travis.ibm.com/cloudFPGA/Doc) job on the Travis CI page.
121121
This is useful when you don't have any changes for the current
122122
[Organization Documentation](#documenting-the-organization)
123123
but you want update the documentation of a [specific cF repository](#documenting-the-cf-repositories).
124124

125-
### 2.2 HowTo - Manual update of a cF repository documentation
125+
### 2.2 Manual update of a cF repository documentation
126126

127127
Clone the [Doc](https://github.com/cloudFPGA/Doc) repo, create a minor commit and push it.
128128
This is useful when you made changes in both the [Organization Documentation](#documenting-the-organization)

0 commit comments

Comments
 (0)