search

scikit-learn / enhancement_proposals

Enhancement proposals for scikit-learn: structured discussions and rational for large additions and modifications
https://scikit-learn-enhancement-proposals.readthedocs.io/en/latest
BSD 3-Clause "New" or "Revised" License
47 stars 34 forks source link

use markdown for easier rendering. #8

Closed amueller closed 5 years ago

amueller commented 5 years ago

I think it might be easier to use markdown for SLEPs so we can directly use github pages instead of having to set up a sphinx build. Open to other opinions of course.

amueller commented 5 years ago

Numpy uses rst, but they also use their main website / doc build to build their NEPs.

amueller commented 5 years ago

hm not entirely sure if this is actually better than sphinx, we'll see

amueller commented 5 years ago

I think I want intersphinx.

jnothman commented 5 years ago

Is there a good reason to not build this with the main docs?

GaelVaroquaux commented 5 years ago

I think I want intersphinx.

Intersphinx rocks!!!

Interesting experiment that you're running. I am very interested in your conclusion.

I love building webpages in pure jekyll with github pages, but I agree that for technical stuff, I really like having the full sphinx artillery.

amueller commented 5 years ago

@jnothman the conclusion of the discussion on the governance doc was to have a separate repo. I don't know how we could have a separate repo and build them together. I'm somewhat in favor of having it in the same repo for the exact reason to build them together but it seemed others preferred this solution. Happy to discuss again, though.

amueller commented 5 years ago

The main reason was to have notifications and git history not mixed up, I think (reason to keep repos separate, not to do separate builds)