django-inspectional-registration icon indicating copy to clipboard operation
django-inspectional-registration copied to clipboard

Published 20 hours ago • verified publisher icon lambdalisue

RFC: Improve doc

Open lambdalisue opened this issue 9 years ago • 3 comments

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)

lambdalisue avatar Feb 26 '16 17:02 lambdalisue

I will help with this.

mick-t avatar May 23 '16 19:05 mick-t

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

mick-t avatar May 24 '16 15:05 mick-t

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 ;-)

lambdalisue avatar May 25 '16 02:05 lambdalisue