MobleyLab / chemper

Repository for Chemical Perception Sampling Tools
MIT License
19 stars 10 forks source link

Doc cleanup #25

Closed davidlmobley closed 5 years ago

davidlmobley commented 6 years ago

Taking a quick look at the chemper docs on chemper.readthedocs.io, I see a few issues:

I think that's it. Overall there's a sense that the big picture is not clear yet.

bannanc commented 6 years ago

@davidlmobley I updated your list to be a checklist so I can check things off when I've completed them. After Jessica and I talked I had basically planned to rewrite the intro page completely to be more big picture and then only focused on chemper. I'll move the smarty/smirky stuff to somewhere else for people who might want to read it, maybe make a Previous Work or Related Work section, let me know if you have a good idea for the name of that section.

The "Make SMIRKS from clustered subgraphs" example refers to "this notebook", which is odd since it's not a notebook

So this page is automatically generated from the example jupyter notebooks (super handy readthedocs thing), probably the best thing to do is to refer to notebooks as "in this example" inside the notebooks so it makes more sense on the website.

bannanc commented 6 years ago

I'm including these in PR #29

bannanc commented 5 years ago

Actually, I've reordered a few things on my todo list, I've included the API points and example comments in PR #41. I am going to close this issue when that is accepted and make a new issue with my personal checklist for the introduction points.