You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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
The text was updated successfully, but these errors were encountered: