Skip to content

Initial doc page #9

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

Merged
merged 10 commits into from
Sep 22, 2015
Merged

Initial doc page #9

merged 10 commits into from
Sep 22, 2015

Conversation

terrytangyuan
Copy link
Member

Just some initial code. Not sure what the doc structure you prefer though.

@terrytangyuan
Copy link
Member Author

@perimosocordiae Travis failed due to this ill-conditioned problem again. Have you added a fixed seed for the test?

@terrytangyuan
Copy link
Member Author

Run the following and then go to doc/build/html to see the html page built by Sphinx:

pip install Sphinx
cd metric-learn/doc
make html

@perimosocordiae
Copy link
Contributor

Re: the flaky test, it's something that I'm aware of but haven't bothered to fix yet. I'll probably add a check in the code to prevent it at the source, if possible.
In the mean time, for non-code changes you can put the string [ci skip] in your commit message and it won't trigger a Travis run.

One consideration for docs: what kinds docs do we want to support building? I would probably only use the html docs, but if you have a case for other formats, that's fine.

Once we get the docs looking nice, I'll host the html docs on a gh-pages branch for easy access.

@terrytangyuan
Copy link
Member Author

I see. Will do. Yep gh-pages is exactly what I have in mind!

@terrytangyuan
Copy link
Member Author

@perimosocordiae Want to merge this first and host it? We can finish the docs later and I might need your help on this too since you are more familiar with the algorithms implemented.

perimosocordiae added a commit that referenced this pull request Sep 22, 2015
@perimosocordiae perimosocordiae merged commit 7707e6e into scikit-learn-contrib:master Sep 22, 2015
@perimosocordiae
Copy link
Contributor

Merged. Thanks for getting started on this!

@terrytangyuan terrytangyuan deleted the dev branch September 22, 2015 19:01
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.

2 participants