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.

Sign up for GitHub

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

Jump to bottom

Add all basic documentation files #25

Merged
merged 1 commit into from
Sep 25, 2023
Merged

Add all basic documentation files #25

merged 1 commit into from
Sep 25, 2023

Conversation

kaqmak
Copy link
Contributor

@kaqmak kaqmak commented Sep 25, 2023

This is just the basic files needed for generating the docs. No documentation has actually been added.
TODO:

  1. Add autodoc in order to generate documentation automatically from the docstring.
  2. Decide on docstring convention (Numpy, google, or Sphinx) see here

@audreyfeldroy
Copy link
Member

I'll merge this already so that I can connect ReadTheDocs. For docstrings, let's use the Sphinx convention.

Thanks for this!

@audreyfeldroy audreyfeldroy merged commit 48efcf7 into crisishistory:main Sep 25, 2023
1 check passed
@audreyfeldroy audreyfeldroy added the hacktoberfest-accepted Issue or PR is approved for anyone who wants it to count toward Hacktoberfest label Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
hacktoberfest-accepted Issue or PR is approved for anyone who wants it to count toward Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kaqmak @audreyfeldroy