DataForScience / DataForScience/epidemik

Sphinx documentation

Open
#1 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
16
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Now that integration with readthedocs is complete, we have to start populating the documentation. There are a few specific things that we should add:

  • Brief overview of the structure of the library
  • High level description of the three main modules
  • Explanation of the arguments for each method
  • Examples of the way to use the package. We can refer to the blog posts for examples of the full functionality

With some luck, the documentation can also serve as the starting point for defining a complete set of tests

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing Read the Docs integration and review the package structure and its three main modules. Use the linked blog posts as sources for usage examples, then document the library overview, module descriptions, method arguments, and examples; the resulting documentation should also identify gaps that can inform a complete test set.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.