multiformats / multiformats/py-multibase

Fix Read the Docs build failures

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

Nobody has claimed this yet.

Dominant language
Python
Stars
25
Forks
9
PR merge metrics
No merged PRs in 30d

Description

The Read the Docs documentation build is currently failing due to:

  1. Deprecated Sphinx configuration settings in docs/conf.py:

    • source_suffix = '.rst' should be source_suffix = {'.rst': 'restructuredtext'}
    • master_doc = 'index' should be root_doc = 'index'
  2. Missing API documentation files (modules.rst and multibase.rst) that need to be generated before the build.

These issues cause warnings that fail the build because fail_on_warning: true is set in .readthedocs.yaml.

This issue tracks the fix for the documentation build process.

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 with docs/conf.py and .readthedocs.yaml, especially the fail_on_warning setting, then inspect how the missing modules.rst and multibase.rst files are expected to be generated. Run the Read the Docs documentation build and verify it completes without warnings from the deprecated settings or missing API documentation files.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.