Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: $ in copied commands #16133

Merged
merged 1 commit into from
Sep 17, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ Install Sphinx and other dependencies (i.e. theme) needed for the documentation.
From the `docs` directory, use `pip`:

```
$ pip install -r requirements-docs.txt
pip install -r requirements-docs.txt
```

Build the documentation like this:

```
$ make html
make html
```

The built documentation will be placed in the `docs/build` directory. Open
Expand All @@ -33,13 +33,13 @@ Helpful documentation build commands
Clean the documentation build:

```
$ make clean
make clean
```

Test and check the links found in the documentation:

```
$ make linkcheck
make linkcheck
```

Documentation on Read The Docs
Expand Down