search

lambdalisue / django-inspectional-registration

Django registration app with Inspection before activation
http://pypi.python.org/pypi/django-inspectional-registration
42 stars 26 forks source link

RFC: Improve doc #61

Open lambdalisue opened 8 years ago

lambdalisue commented 8 years ago

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
  3. Write reStructuredText like docs/about_registration_supplement.rst
  4. Run $ (cd docs; make html)
mick-t commented 8 years ago

I will help with this.

mick-t commented 8 years ago

Are the rst automatically generated? If they are, how to rebuild them?

lambdalisue commented 8 years ago

Thanks for the contribution!

If you modify docstring in source code, you need to run

$ sphinx-apidoc -f -o docs/ src

To apply the changes ;-)