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.

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

Add docs skeleton with autogenerated module docs #30

Merged
merged 1 commit into from
May 7, 2018

Conversation

vladcalin
Copy link
Contributor

I generated the default docs structure using sphinx and added auto-generated docs for modules.

I though that the project needs at least the following sections:

  • installation guide
  • some examples of basic usage that will help new users to get a quick grasp of what this library is capable of
  • some pointers on how to extend certain features, such as creating a new loader
  • contribute - a guide for wanna be contributors (how to create pull requests, how to create an issue, etc). This can import from CONTRIBUTING.rst from the root of the project.
  • Module reference - api documentation based on docstrings.

@coveralls
Copy link

coveralls commented Oct 15, 2017

Coverage Status

Coverage remained the same at 81.306% when pulling 2a703bf on vladcalin:add-docs into 161d101 on rochacbruno:master.

@vladcalin
Copy link
Contributor Author

Hey @rochacbruno can you look over this? It's staying open for quite some time now. The Travis check is failing from some pep8 issues in the code and has nothing to do with the changes from this PR.

@rochacbruno rochacbruno merged commit 31668ba into dynaconf:master May 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants