Skip to content

The existing documentation is incompatible with Sphinx [Bug]  #5

@prithviulm

Description

@prithviulm

Version

Development

What is affected by the bug?

The docstrings will not render properly on RTD using Sphinx.

When does the bug occur?

When building the docs.

How do we replicate the issue?

Build the docs locally or on RTD.

Expected behavior

Should not be getting yelled at endlessly for syntax errors relating to dostring formatting/ pointing nowhere/ unknown syntax/ whatever else.

Relevant log output

No response

Additional Comments

It is going to be an incredible journey trying to standardise the existing docstrings because they are all written differently. It might be possible to automate this task either using copilot or otherwise.

No response

Contact Details

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions