Join GitHub today
GitHub is home to over 20 million developers working together to host and review code, manage projects, and build software together.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
Already on GitHub? Sign in to your account
Sphinx based documentation #428
Comments
betatim
added Documentation Moderate
labels
Jul 10, 2017
|
No objection on my side. If you have experience with Sphinx and could setup the doc with it, then let's go for it! Also, Sphinx is more widely adopted than our hackish doc builder, which means it should be easier to maintain (by us and future us). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
betatim commentedJul 10, 2017
Thoughts on switching to sphinx?
Our current documentation system has served us well so far so switching isn't the highest priority. For me personally it would be easier to use sphinx (because other projects use it, so one less tool to use) and we could maybe remove some of the documentation from
skopt.__doc__etc. There are also nice utilities like sphinx-gallery which people will recognise from other projects.The reason I am thinking about documentation is that I think we need to structure our examples a bit better/add some links and narrative that tell new people in which order to read them.
Thoughts?