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

Deliverables Thursday Nov. 5 #15

Open
4 of 8 tasks
Luigi-PastorePica opened this issue Nov 2, 2020 · 0 comments
Open
4 of 8 tasks

Deliverables Thursday Nov. 5 #15

Luigi-PastorePica opened this issue Nov 2, 2020 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation project setup Minimum project setup tasks

Comments

@Luigi-PastorePica
Copy link
Owner

Luigi-PastorePica commented Nov 2, 2020

  • Set up documentation for project
  • Host documentation under readthedocs
  • Set up API autodocumentation, include at least 4 elements
  • Add readthedocs badge to the Readme.
  • Optional:
    • Remember to write down documentation for everything that we have done for this class. (Problems, justification for decisions. What tools and frameworks are used.)
    • Add link to readthedocs page in the Readme.
    • Add Readme's content to the top of the readthedocs page.
@Luigi-PastorePica Luigi-PastorePica changed the title Deliverables Thursday November 5 Deliverables Thursday Nov 5 Nov 2, 2020
@Luigi-PastorePica Luigi-PastorePica changed the title Deliverables Thursday Nov 5 Deliverables Thursday Nov. 5 Nov 2, 2020
@Luigi-PastorePica Luigi-PastorePica self-assigned this Nov 2, 2020
@Luigi-PastorePica Luigi-PastorePica added documentation Improvements or additions to documentation project setup Minimum project setup tasks labels Nov 2, 2020
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 project setup Minimum project setup tasks
Projects
None yet
Development

No branches or pull requests

1 participant