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

Add some more docs - readthedocs? #85

Closed
hayesla opened this issue May 16, 2023 · 2 comments · Fixed by #87
Closed

Add some more docs - readthedocs? #85

hayesla opened this issue May 16, 2023 · 2 comments · Fixed by #87

Comments

@hayesla
Copy link
Member

hayesla commented May 16, 2023

As more features are now available (e.g. query SOOP), and with a plan to add more info from different tables I think some documentation would help

I think we should build a readthedocs for sunpy_soar

Proposed solution

do it

@wtbarnes
Copy link
Member

Given #84 and the proposed additions in #66 and #46, I think this is needed. The simple documentation in the README will quickly become insufficient as the amount of functionality here grows. However, if we are ultimately going to merge this into sunpy, I'm less inclined to have a separate docs page that we have to maintain.

@wtbarnes
Copy link
Member

From #85

Following the SunPy affiliated package review, I mentioned that some more documentation about the package would be useful. In particular more documentation regarding some higher level stuff about the the client interacts with the SOAR which would be useful for future developers. It would also be nice to have some more examples on how to use sunny-soar.

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

Successfully merging a pull request may close this issue.

2 participants