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

Documentation #5

Open
drvinceknight opened this issue Nov 28, 2016 · 2 comments
Open

Documentation #5

drvinceknight opened this issue Nov 28, 2016 · 2 comments
Assignees
@Nikoleta-v3
Labels
in progress

Comments

@drvinceknight
Copy link
Collaborator

Let's add some sphinx documentation: with example calls.
@Nikoleta-v3
Copy link
Member

Write some basic documentation for the before presenting at the CW17.

@Nikoleta-v3 Nikoleta-v3 self-assigned this Mar 25, 2017
@Nikoleta-v3
Copy link
Member

Initial structure

  • Installation
  • Tutorials
    • Tutorial 1: Retrieve a singe article
    • Tutorial 2: Retrieve an article from various APIs
    • Tutorial 3: Retrieving a large number of articles from different APIs
  • Reference
    • list of apis
    • results set

Nikoleta-v3 added a commit that referenced this issue Mar 26, 2017
@Nikoleta-v3
Early documentation
dc39af3 
Fixes part of #5
Structure:

- Installation
- Tutorials
  - Tutorial 1: Retrieve a singe article
  - Tutorial 2: Retrieve an article from various APIs
  - Tutorial 3: Retrieving a large number of articles from different APIs
- Reference
  - list of apis
  - results set
@Nikoleta-v3 Nikoleta-v3 mentioned this issue Mar 26, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Nikoleta-v3 Nikoleta-v3

Labels
in progress
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@drvinceknight @Nikoleta-v3