pytroll / pytroll/trollflow2

Documentation index empty, module index 404

Open
#95 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
9
Forks
17
Avg merge
12d 4h
Merged PRs (30d)
6

Description

Describe the bug

In the documentation on readthedocs, the link to the Module Index results in Error 404. The link to the Index works, but the index is empty.

To Reproduce

Expected behavior

  • I expect that clicking on the anchor Index gives me a list of all help topics.
  • I expect that clicking on the anchor Module Index gives me a list of all modules and their documentation pages.

Actual results

  • Clicking on the anchor Index gives me a page that is empty apart from headers.
  • Clicking on the anchor Module Index results in Error 404.

Additional context

Some of the sections on the main documentation page are empty. For example, I wonder if there's supposed to be any content between the headings The launcher and Plugins. However, since I'm not sure what it is intended here, I'm not sure if this is a bug.

Contributor guide

No contributing guide indexed for this repository

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 Index and Module Index links on the Read the Docs site described in the issue. Then inspect the documentation build configuration and source pages to determine why the index is empty and the module index returns 404. Done means both links resolve to populated, relevant documentation pages.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.