scipy-conference / scipy_proceedings

Tools used to generate the SciPy conference proceedings
Other
230 stars 528 forks source link

Misc notes on paper building process. #687

Closed Carreau closed 1 week ago

Carreau commented 2 years ago

These are some misc notes on collaborating with someone to write one of the proceeding.

1) I think the rst file should be removed from the output folder after build, or renamed. Reason begin there is a non zero risk for someone to start editing the things in output/build/paper.rst, and loose work later. 😭

2) the default branch not being named main (or master), seem to be confusing.

Thanks !

deniederhut commented 2 years ago

the default branch not being named main (or master), seem to be confusing.

The logic there is that we have a different branch for each year of the conference, and that this keeps giant clumps of paper paraphernalia (like pngs) out of the dev, the development branch. I would be happy to chat with you about more clever ways of achieving these goals.

I think the rst file should be removed from the output folder after build, or renamed.

Yup. We do have a make clean target, but that's probably not sufficient.

Carreau commented 2 years ago

The logic there is that we have a different branch for each year of the conference, and that this keeps giant clumps of paper paraphernalia (like pngs) out of the dev, the development branch. I would be happy to chat with you about more clever ways of achieving these goals.

What about renaming master/main or whatever once the proceeding is published, so that at least during the submission period, it's a name that is commonly used ?

deniederhut commented 2 years ago

Not a bad idea -- I'll bring it up with the committee

rowanc1 commented 1 week ago

Some links to docs: