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

Improve the chapter on working on the scipy-lectures #146

Open
GaelVaroquaux opened this issue Aug 28, 2015 · 1 comment
Open

Improve the chapter on working on the scipy-lectures #146

GaelVaroquaux opened this issue Aug 28, 2015 · 1 comment
Assignees

Comments

@GaelVaroquaux
Copy link
Member

  • The chapter is in the 'guide' directory
  • It should explain quickly
    • How to build (using sphinx)
    • How to doctest
    • The use of examples to generate figures (ie: figure are not allowed to be checked in)
    • The use of intersphinx to link across projects
  • It should stress our style guide:
    • Chapters should be readable / doable as a tutorial in 1.5 hours to 2 hours max (which implies limiting the amount of information)
    • Links (internal, to others projects and to Wikipedia) matter terribly
    • Jargon is to be avoided at all cost
    • The use of restructured text directives, such as topic, note, seealso, tip, sidebar, is strongly encouraged
@GaelVaroquaux GaelVaroquaux changed the title Add a chapter on working on the scipy-lectures Improve the chapter on working on the scipy-lectures Sep 23, 2015
@emmanuelle
Copy link
Member

I did not see this issue before I started working on #260. Some points listed above have been fixed but not all of them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

4 participants