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

Aggregate whats_new and api_changes rst files for docs #4543

Closed
tacaswell opened this issue Jun 19, 2015 · 0 comments · Fixed by #5066
Closed

Aggregate whats_new and api_changes rst files for docs #4543

tacaswell opened this issue Jun 19, 2015 · 0 comments · Fixed by #5066
Assignees
Labels
Documentation mentored: hackathon Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Milestone

Comments

@tacaswell
Copy link
Member

We are currently collecting whats_new and api_changes in separate rst files which we did to avoid the rebasing/manual merging pain we had in the run up to the 1.4 release, but to build the docs for 1.5 we need to merge all of these back into a single rst. The options I see are:

  • do it manually
  • adapt IPython whats_new scraping script, do it permanently, automated commits and all
  • do it on the fly at documentation build time
  • sort out how to get sphinx to auto-include a bunch of files

This seems like a good project for the sprints.

@tacaswell tacaswell added Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. mentored: hackathon labels Jun 19, 2015
@tacaswell tacaswell added this to the next point release milestone Jun 19, 2015
@tacaswell tacaswell self-assigned this Sep 15, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation mentored: hackathon Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant