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

Documentation #15

Open
not7cd opened this issue Jun 8, 2018 · 5 comments
Open

Documentation #15

not7cd opened this issue Jun 8, 2018 · 5 comments
Assignees
@skulumani

Comments

@not7cd
Copy link
Contributor

not7cd commented Jun 8, 2018

There are no available docs
@skulumani
Copy link
Owner

Thanks! This is something I need to work on when I get some free time!

Many of the functions do have documentation but I want to setup at least a few pages that demonstrate larger usage examples.

@skulumani skulumani self-assigned this Jun 8, 2018
@skulumani
Copy link
Owner

Pydoc or Readdocs would be nice #12

@not7cd
Copy link
Contributor Author

not7cd commented Jun 10, 2018

I could do it, in a week or two

@skulumani
Copy link
Owner

skulumani commented Jun 10, 2018 via email

@skulumani
Copy link
Owner

Need to fix the docstring style to work with Sphinx

https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google

Also document the argparse tools (predict and tle and others)

https://sphinx-argparse.readthedocs.io/en/stable/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@skulumani skulumani

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@not7cd @skulumani