[go: up one dir, main page]

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

first attempt at converting docs to sphinx #26

Closed
wants to merge 1 commit into from

Conversation

hickford
Copy link
Contributor

Attempt at #25

You can see the results at http://chardet-matthickford.readthedocs.org/en/latest/

There are many problems that need fixing before this is worthy of publishing.

I don't know restructured text.

@dan-blanchard
Copy link
Member

Like you said, we'll have to fix some things before publishing, but this is a great first step!

@@ -0,0 +1 @@
_*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems rather liberal. It's unlikely we'll need a directory with an _ leading it off, but I'd still rather be explicit with what we're ignoring (which I'm assuming is _build).

@dan-blanchard dan-blanchard reopened this Dec 2, 2014
dan-blanchard added a commit that referenced this pull request Jan 5, 2015
Thanks to @hickford for getting this started!

I've taken his work and built on it by:
- removing files we no longer need
- fixing headings
- removing extraneous header/footer stuff
- adding auto-generated API docs
@dan-blanchard
Copy link
Member

I merged this, but also fixed some stuff at the same time. Apparently I should have done that in separate commits, so apologies to @hickford for there not being commits that have his name attached to them.

@hickford
Copy link
Contributor Author
hickford commented Jan 5, 2015

Well done! No worries. Looks good to me http://chardet.readthedocs.org/en/latest/

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.

3 participants