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

Unify and update documentation #25

Closed
blthayer opened this issue Mar 27, 2020 · 2 comments
Closed

Unify and update documentation #25

blthayer opened this issue Mar 27, 2020 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@blthayer
Copy link
Collaborator

  • Convert README file to rst
  • Split README file out into different files so it can be included in the API documentation
  • Include README content in API documentation
  • Clean up and update documentation
@blthayer blthayer added the documentation Improvements or additions to documentation label Mar 27, 2020
@blthayer blthayer added this to the JOSS Paper milestone Mar 27, 2020
@blthayer blthayer self-assigned this Mar 27, 2020
@blthayer
Copy link
Collaborator Author

@mzy2240 @SmartJingJing123 - So that our documentation can be more unified, I'd like it all (with the exception of the JOSS paper itself) to be in restructure text. Here's a quick primer:
http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

@blthayer
Copy link
Collaborator Author

This is more or less done, and we have several different issues open for further tweaking the documentation.

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
Projects
None yet
Development

No branches or pull requests

1 participant