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

RFC: Improve doc #61

Open
lambdalisue opened this issue Feb 26, 2016 · 3 comments
Open

RFC: Improve doc #61

lambdalisue opened this issue Feb 26, 2016 · 3 comments
Labels
help wanted

Comments

@lambdalisue
Copy link
Owner

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)
@lambdalisue lambdalisue changed the title Improve doc RFC: Improve doc Feb 26, 2016
@lambdalisue lambdalisue mentioned this issue Feb 26, 2016
Closed
@mick-t
Copy link
Contributor

mick-t commented May 23, 2016

I will help with this.

mick-t pushed a commit to sbgrid/django-inspectional-registration that referenced this issue May 23, 2016
Issue lambdalisue#61, improved English documentation.
d6dd945
@mick-t
Copy link
Contributor

mick-t commented May 24, 2016

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

@lambdalisue
Copy link
Owner Author

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lambdalisue @mick-t