Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatic documentation.json generation #203

Open
JayDwee opened this issue Jun 1, 2021 · 0 comments · May be fixed by #235
Open

Automatic documentation.json generation #203

JayDwee opened this issue Jun 1, 2021 · 0 comments · May be fixed by #235
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@JayDwee
Copy link
Member

JayDwee commented Jun 1, 2021

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

@JayDwee JayDwee added documentation Improvements or additions to documentation enhancement New feature or request medium priority labels Jun 1, 2021
@Kaspiaan Kaspiaan pinned this issue Jul 23, 2021
@Kaspiaan Kaspiaan unpinned this issue Jul 23, 2021
@Kaspiaan Kaspiaan pinned this issue Jul 23, 2021
@Kaspiaan Kaspiaan assigned Kaspiaan and unassigned Kaspiaan Jul 26, 2021
@MoistBiscuits MoistBiscuits self-assigned this Aug 2, 2021
@MoistBiscuits MoistBiscuits linked a pull request Aug 2, 2021 that will close this issue
10 tasks
@MoistBiscuits MoistBiscuits linked a pull request Aug 2, 2021 that will close this issue
10 tasks
@Kaspiaan Kaspiaan unpinned this issue Aug 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants