Skip to content

Move REST API docs support to sphinx-scylladb-theme #722

@dgarcia360

Description

@dgarcia360

Motivation

We generate API documentation for https://github.com/scylladb/scylla-cloud-doc using Redocly and a set of custom scripts. However, it would be useful for other projects to generate their own REST API documentation. To achieve this, we could consider moving the documentation generation logic to this project.

Considerations

As part of this effort, we might need to add npm support to the toolchain. See https://github.com/scylladb/scylla-cloud-doc/pull/113#issuecomment-1467700163

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions