scylladb / sphinx-scylladb-theme

The documentation toolchain for Scylla projects.
https://sphinx-theme.scylladb.com
Apache License 2.0
12 stars 13 forks source link

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

Open dgarcia360 opened 1 year ago

dgarcia360 commented 1 year ago

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

dgarcia360 commented 11 months ago

Reopening