Skip to content
This repository was archived by the owner on Aug 23, 2020. It is now read-only.
This repository was archived by the owner on Aug 23, 2020. It is now read-only.

RFC: Improve doc #61

@lambdalisue

Description

@lambdalisue

Like #11 (comment)

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)

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions