Skip to content

Commit 1c39cce

Browse files
Explicitly link to the ReadTheDocs site from the README (#1058)
* Explicitly link to the ReadTheDocs site from the README * Use https:// URL in README
1 parent aff3339 commit 1c39cce

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@ $ uvx usethis tool ruff
5656
$ pipx run usethis tool ruff
5757
```
5858

59+
## 📜 Documentation
60+
61+
The usethis documentation is available at [usethis.readthedocs.io](https://usethis.readthedocs.io/en/stable/).
62+
63+
Additionally, the command line reference documentation can be viewed with `usethis --help`.
64+
5965
## 🖥️ Command Line Interface
6066

6167
### Start a New Project

tests/docs/test_readme.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,13 @@ def test_assemble_readme_from_docs(usethis_dev_dir: Path):
4040
"`](reference.md#",
4141
"`](https://usethis.readthedocs.io/en/stable/cli/reference#",
4242
)
43+
parts.append("""\
44+
## 📜 Documentation
45+
46+
The usethis documentation is available at [usethis.readthedocs.io](https://usethis.readthedocs.io/en/stable/).
47+
48+
Additionally, the command line reference documentation can be viewed with `usethis --help`.
49+
""")
4350
parts.append(cli_overview_content)
4451
parts.append(_get_doc_file(usethis_dev_dir / "docs" / "example-usage.md"))
4552
parts.append(_get_doc_file(usethis_dev_dir / "docs" / "similar-projects.md"))

0 commit comments

Comments
 (0)