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

Update and integrate API documentation #368

Open
markbrough opened this issue Aug 18, 2022 · 1 comment
Open

Update and integrate API documentation #368

markbrough opened this issue Aug 18, 2022 · 1 comment

Comments

@markbrough
Copy link
Member

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

There are a few issues with the API documentation at the moment:

Describe the solution you’d like

  • integrate with existing NuxtJS app (also then potentially simplifying translation)
  • generate basic documentation from API docstrings

Describe alternatives you’ve considered

Leaving everything more or less as it is (i.e. just updating Sphinx)

Additional context

Custom solution:

Using Swagger:

@ghost
Copy link

ghost commented Aug 19, 2022

I don't have any immediate thoughts on good technical solutions but certainly the problems make sense.

I'm not sure if static help pages need to be in NuxtJS tho - I see that as having strengths for interactive pages (eg the query builder front page). Help pages could be kept simple and just be served by flask, which handily just had I18N options added.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant