multiformats / multiformats/py-multibase
Fix Read the Docs build failures
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:
-
Deprecated Sphinx configuration settings in
docs/conf.py:source_suffix = '.rst'should besource_suffix = {'.rst': 'restructuredtext'}master_doc = 'index'should beroot_doc = 'index'
-
Missing API documentation files (
modules.rstandmultibase.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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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