Skip to content

Commit 4a20670

Browse files
authored
Merge pull request #108 from coderefinery/radovan/cosmetics
Cosmetics
2 parents 289c241 + d01e71a commit 4a20670

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

_episodes/05-rtd.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,17 @@ objectives:
6060
>
6161
> Inside the cloned repository, run
6262
>```shell
63-
> sphinx-build doc _build
63+
>$ sphinx-build doc _build
6464
>```
6565
> and verify the result in your browser.
6666
>
6767
> #### Test HTML pages links
68-
>
69-
> Inside the cloned repository, run `sphinx-build doc -W -blinkcheck -d _build/doctrees _build/html` in order to check the integrity of all external links.
70-
>
68+
>
69+
> Inside the cloned repository, check the integrity of all external links:
70+
>```
71+
>$ sphinx-build doc -W -blinkcheck -d _build/doctrees _build/html
72+
>```
73+
>
7174
> ### Step 2: Enable the project on [Read the Docs](https://readthedocs.org)
7275
>
7376
> Now you will import a project to Read the Docs by connecting to GitHub. This
@@ -80,7 +83,7 @@ objectives:
8083
> - Log into [Read the Docs](https://readthedocs.org) and visit your [dashboard](https://readthedocs.org/dashboard/)
8184
> - Click "Import a Project"
8285
> - Select "Connect to GitHub", and choose the word-count repository
83-
> - Rename the project to user-word-count (replacing "user" with your GitHub username)
86+
> - Rename the project to user-word-count (replacing "user" with your GitHub username: we need a unique project name)
8487
> - Click "Next"
8588
>
8689
> That's it! Your site should now be live on

0 commit comments

Comments
 (0)