Fix broken links in the generated rst documentation

Open Beginner friendly
#16,204 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start with the generator's rst.py file and inspect how Markdown-style links are transformed. Reproduce the generated RST for [Text] (URL) and [Text][Ref] patterns, then verify the resulting hyperlinks resolve correctly, including the cloud.google.com documentation link; done means the generated RST contains valid, non-broken links.

Written by the indexing model from the issue text.

Description

priority: p2 type: docs

Update rst.py file in the generator and ensure that the generated rst documentation does not have broken links. Also validate that the links work on cloud.google.com.

  • Correctly transform [Text] (URL) and fix broken [Text][Ref] patterns into valid RST hyper-links
Dominant language
Python
Stars
5.4k
Forks
1.8k
Avg merge
1d 17h
Merged PRs (30d)
93

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from googleapis/google-cloud-python

All issues in googleapis/google-cloud-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.