Skip to content

Automatic documentation.json generation #203

Description

@JayDwee

Is your feature request related to a problem? Please describe.

Currently developers need to manually add new/ altered commands to documentation.json to be reflected in the frontend which is often either forgotten or just a hassle.

Describe the solution you'd like

Au automated generation of the documentation.json file should be generated as per requested spec utilising the Restructure Text docstrings throughout the code.
On any push/ commit to master, this script should be run to generate the docs and commit them through the use of GitHub Actions

Additional: Add an example to each command docstring

Describe alternatives you've considered

Sphinx

Additional context

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions