lambdalisue/django-inspectional-registration

RFC: Improve doc

Open

#61 opened on Feb 26, 2016

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (24 forks)github user discovery
help wanted

Repository metrics

Stars
 (41 stars)
PR merge metrics
 (PR metrics pending)

Description

Like https://github.com/lambdalisue/django-inspectional-registration/issues/11#issuecomment-189370666

But....... Well........ English.....

How to add document

From source code

  1. Write docstring to source code files like registration/backends/defalt/__init__.py

  2. Run

    $ sphinx-apidoc -f -o docs/ src
$ (cd docs; make html)
Document
  1. Write reStructuredText like docs/about_registration_supplement.rst
  2. Run $ (cd docs; make html)

Contributor guide

Research direction
Follow the instructions in the issue to add docstrings to source code or write reStructuredText files, then build the documentation with Sphinx.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80