@@ -35,13 +35,13 @@ counting the frequency distribution of words in a given file and some
35
35
documentation generated using Sphinx. For bigger projects, we can have
36
36
more source files.
37
37
38
- **Step 1:** Go to the [word-count project template](https://github.com/coderefinery/word-count /generate)
38
+ **Step 1:** Go to the [documentation-example project template](https://github.com/coderefinery/documentation-example /generate)
39
39
on GitHub and create a copy to your namespace ("Generate", since this
40
40
is a template repository).
41
41
42
42
**Clone the repository**
43
43
44
- The repository contains following two folders, among few other files and folders :
44
+ The repository contains following two folders, among few other files:
45
45
- **source** folder contains the source code
46
46
- **doc** folder contains the Sphinx documentation
47
47
@@ -98,12 +98,12 @@ You don't need to understand all of the above, but you
98
98
might spot familiar commands in the `run:` sections.
99
99
100
100
- Add, commit and push to GitHub
101
- - Check the action at `https://github.com/<myuser>/word-count /actions`.
101
+ - Check the action at `https://github.com/<myuser>/documentation-example /actions`.
102
102
Replace `<myuser>` with your GitHub username.
103
103
104
104
**Step 2:** Enable GitHub Pages
105
105
106
- - Go to `https://github.com/<myuser>/word-count /settings/pages`
106
+ - Go to `https://github.com/<myuser>/documentation-example /settings/pages`
107
107
- In the "Source" section, choose "gh-pages" in the dropdown menu and click
108
108
save
109
109
- (You should be able to verify the pages deployment in the Actions list)
@@ -112,7 +112,7 @@ Replace `<myuser>` with your GitHub username.
112
112
**Verify the result**
113
113
114
114
That's it! Your site should now be live on
115
- `https://<myuser>.github.io/word-count /` (replace username).
115
+ `https://<myuser>.github.io/documentation-example /` (replace username).
116
116
117
117
**Verify refreshing the documentation**
118
118
0 commit comments