docker / docker/docker-py

Unable to navigate the API documentation at docker-py.readthedocs.io

Open
#2,024 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7.2k
Forks
1.7k
Avg merge
13d 8h
Merged PRs (30d)
2

Description

Unable to scroll through the entire Navigation Side panel at readthedocs.io https://docker-py.readthedocs.io/en/stable/api.html.
For example I cannot navigate the entire documentation of Low-level API (since there is no scroll bar in navigation side pane). Added Screen shot for refrence,
docker-py-docs-github-issue

Is this an issue with readthedocs settings (sphinx theme settings) to provide side panel with a scroll bar.

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.

Research direction

Start by reproducing the navigation problem at the linked docker-py API documentation page and reviewing the referenced screenshot. Determine whether the missing side-panel scrollbar is controlled by the project's Sphinx or Read the Docs settings; done means the full Low-level API navigation can be reached and scrolled.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.