Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation in en_US #100

Open
osantana opened this issue Sep 29, 2017 · 3 comments
Open

Add documentation in en_US #100

osantana opened this issue Sep 29, 2017 · 3 comments
Labels
difficulty:hard hacktoberfest help wanted priority:low

Comments

@osantana
Copy link
Contributor

No description provided.

@robertoduessmann
Copy link
Contributor

robertoduessmann commented Oct 9, 2017 •
edited
Loading

I'd like to help with this. Do you have any idea or doc to be based?
Because I was confused when I access documentation folder...

@osantana
Copy link
Contributor Author

osantana commented Oct 10, 2017 •
edited
Loading

Create a "docs" folder with sphinx-build and create documentation for:

  • Basic tutorial with some client APIs basic usage (eg. SIGEP, SRO, etc)
  • Basic tutorial for Posting List / ShippingLabel PDF generation
  • Reference of main models APIs

@osantana osantana mentioned this issue Oct 10, 2017
Open
3 tasks
@robertoduessmann robertoduessmann mentioned this issue Oct 11, 2017
Merged
@robertoduessmann
Copy link
Contributor

robertoduessmann commented Oct 11, 2017 •
edited
Loading

Very nice, now I understood @osantana . I opened the pull request #101 with a skeleton suggestion to organize the docs.

Do you can take a look and comment what you think? I created some md files to simplify the access to docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
difficulty:hard hacktoberfest help wanted priority:low
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@osantana @robertoduessmann