Documentation and package layout

jorgepiloto commented 5 years ago

As I commented in the chat, although the package documentation is deployed in Read the docs it is currently failing as I saw here: https://readthedocs.org/projects/orbit-determinator/

Documentation is fundamental if we want a project to be useful for external users and none experienced ones. But is not only that, it helps contributors to have a general idea on the package, how to run different examples and what is still needed to to.

I saw that the package contains examples, tests, docs but they are not really well organized. Also the README.md could be improved to attract more people to the project.

Therefore my suggestions are:

[x] Create a good docs layout
[ ] Improve README.md adding different sections such us: definition, better installation guide, contributors section, brief examples, contact section...
[ ] Organize the package following this ideas: https://blog.ionelmc.ro/2014/05/25/python-packaging/

Tell me what you think :rocket:

Leotuashutosh commented 4 years ago

I would like to work on this if this is still open

hornig commented 4 years ago

hey @Leotuashutosh , there can always be improvement. :)

aerospaceresearch / orbitdeterminator

Documentation and package layout #155