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

Better documentation #24

Closed
carlio opened this issue Apr 2, 2014 · 0 comments
Closed

Better documentation #24

carlio opened this issue Apr 2, 2014 · 0 comments

Comments

@carlio
Copy link
Member

carlio commented Apr 2, 2014

The current README is becoming insufficient to explain all of the features of prospector, and is missing things like the motivation for the project and clarification of some behaviour. A nice big "Read the docs" page would be useful.
@carlio carlio mentioned this issue Apr 2, 2014
Closed
carlio added a commit that referenced this issue Sep 28, 2014
@carlio
Initial structure for proper documentation. Currently this is just th…
9bddc06 
…e README.md in Sphinx form. [refs #24]
carlio added a commit that referenced this issue Sep 28, 2014
@carlio
Fixing the RST formatting of code blocks [refs #24]
a0425b1
carlio added a commit that referenced this issue Oct 2, 2014
@carlio
Adding more documentation [refs #24]
4ac9b74
carlio added a commit that referenced this issue Oct 2, 2014
@carlio
[refs #24] Adding some helper code to get hold of an argparse parser,…
f11bd95 
… which is used when generating the documentation
carlio added a commit that referenced this issue Oct 2, 2014
@carlio
[refs #24] Small edit, mainly to kick off a new build on readthedocs
95550a4
carlio added a commit that referenced this issue Oct 2, 2014
@carlio
[refs #24] Fixing some formatting problems with the output created by…
8d98e1c 
… readthedocs
carlio added a commit that referenced this issue Oct 3, 2014
@carlio
[refs #24] Further additions to documentation, mostly surrounding pro…
2854917 
…files
carlio added a commit that referenced this issue Oct 3, 2014
@carlio
Adding the last bits of documentation and removing some unecessary fi…
aa48aa3 
…les [refs #24]
@carlio carlio closed this as completed Oct 3, 2014
carlio added a commit that referenced this issue Oct 3, 2014
@carlio
[refs #24] Updating the readme to include information about the docum…
ba7e463 
…entation on readthedocs.org, and removing some information which is now better found in the full documentation
carlio added a commit that referenced this issue Oct 3, 2014
@carlio
[refs #24] Adding a link to the profile documentation to the main README
11ba287
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@carlio