Skip to content

Fix Read the Docs build failures #31

@acul71

Description

@acul71

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions