Discussion:
[racket] scribble and .gitignore
Jon Zeppieri
2015-03-14 17:30:26 UTC
Permalink
I've been looking at the .gitignore files in various racket packages,
and the ones I've seen don't ignore files generated by scribble (.html
.css, etc.). So what is the common practice for keeping those files
out of source control?
____________________
Racket Users list:
http://lists.racket-lang.org/users
WarGrey Gyoudmon Ju
2015-03-14 18:33:10 UTC
Permalink
I use ./compiled as the dest directory so that all generated files can be
omitted in .gitignore once and for all.
Post by Jon Zeppieri
I've been looking at the .gitignore files in various racket packages,
and the ones I've seen don't ignore files generated by scribble (.html
.css, etc.). So what is the common practice for keeping those files
out of source control?
____________________
http://lists.racket-lang.org/users
Matthew Flatt
2015-03-14 18:38:53 UTC
Permalink
Ignoring "compiled" is right, but documentation goes to "doc". The
"compiled" and "doc" directories should cover all files that are
generated by Racket tools.
Post by WarGrey Gyoudmon Ju
I use ./compiled as the dest directory so that all generated files can be
omitted in .gitignore once and for all.
Post by Jon Zeppieri
I've been looking at the .gitignore files in various racket packages,
and the ones I've seen don't ignore files generated by scribble (.html
.css, etc.). So what is the common practice for keeping those files
out of source control?
____________________
http://lists.racket-lang.org/users
____________________
http://lists.racket-lang.org/users
____________________
Racket Users list:
http://lists.racket-lang.org/users
Jon Zeppieri
2015-03-14 18:41:54 UTC
Permalink
While I'm writing documentation, I often use DrRacket to generate
HTML, and -- at least, with my configuration as-is -- it creates files
in the same directory where the .scrbl files are. Is there a way to
change the destination directory used by DrRacket's scribble mode?
Post by Matthew Flatt
Ignoring "compiled" is right, but documentation goes to "doc". The
"compiled" and "doc" directories should cover all files that are
generated by Racket tools.
Post by WarGrey Gyoudmon Ju
I use ./compiled as the dest directory so that all generated files can be
omitted in .gitignore once and for all.
Post by Jon Zeppieri
I've been looking at the .gitignore files in various racket packages,
and the ones I've seen don't ignore files generated by scribble (.html
.css, etc.). So what is the common practice for keeping those files
out of source control?
____________________
http://lists.racket-lang.org/users
____________________
http://lists.racket-lang.org/users
____________________
Racket Users list:
http://lists.racket-lang.org/users
Robby Findler
2015-03-14 19:06:58 UTC
Permalink
I could certainly change that use a doc subdirectories if people think
that's the right thing.

Robby
Post by Jon Zeppieri
While I'm writing documentation, I often use DrRacket to generate
HTML, and -- at least, with my configuration as-is -- it creates files
in the same directory where the .scrbl files are. Is there a way to
change the destination directory used by DrRacket's scribble mode?
Post by Matthew Flatt
Ignoring "compiled" is right, but documentation goes to "doc". The
"compiled" and "doc" directories should cover all files that are
generated by Racket tools.
Post by WarGrey Gyoudmon Ju
I use ./compiled as the dest directory so that all generated files can
be
Post by Matthew Flatt
Post by WarGrey Gyoudmon Ju
omitted in .gitignore once and for all.
Post by Jon Zeppieri
I've been looking at the .gitignore files in various racket packages,
and the ones I've seen don't ignore files generated by scribble (.html
.css, etc.). So what is the common practice for keeping those files
out of source control?
____________________
http://lists.racket-lang.org/users
____________________
http://lists.racket-lang.org/users
____________________
http://lists.racket-lang.org/users
Neil Van Dyke
2015-03-14 19:22:34 UTC
Permalink
Post by Robby Findler
I could certainly change that use a doc subdirectories if people think
that's the right thing.
I don't know, but (especially if the current default changes), we should
be able to force the target directory from the command line and the
API. (Tools like McFly will need to control where the files will go.)

Neil V.

____________________
Racket Users list:
http://lists.racket-lang.org/users
Robby Findler
2015-03-14 19:26:40 UTC
Permalink
Yes you can do that. We are talking about the location where files are put
when you click the button in Drracket, right?
Post by Neil Van Dyke
Post by Robby Findler
I could certainly change that use a doc subdirectories if people think
that's the right thing.
I don't know, but (especially if the current default changes), we should
be able to force the target directory from the command line and the API.
(Tools like McFly will need to control where the files will go.)
Neil V.
Jon Zeppieri
2015-03-14 19:46:35 UTC
Permalink
On Sat, Mar 14, 2015 at 3:26 PM, Robby Findler
Post by Robby Findler
Yes you can do that. We are talking about the location where files are put
when you click the button in Drracket, right?
Yes (at least, that's what I'm talking about). And I'm in favor of the
change you suggested previously.

-Jon
Post by Robby Findler
Post by Neil Van Dyke
Post by Robby Findler
I could certainly change that use a doc subdirectories if people think
that's the right thing.
I don't know, but (especially if the current default changes), we should
be able to force the target directory from the command line and the API.
(Tools like McFly will need to control where the files will go.)
Neil V.
____________________
http://lists.racket-lang.org/users
____________________
Racket Users list:
http://lists.racket-lang.org/users
Alexander D. Knauth
2015-03-15 00:33:17 UTC
Permalink
Post by Jon Zeppieri
While I'm writing documentation, I often use DrRacket to generate
HTML, and -- at least, with my configuration as-is -- it creates files
in the same directory where the .scrbl files are. Is there a way to
change the destination directory used by DrRacket's scribble mode?
I would definitely want to be able to set this to something like a doc subdirectory.

As it is, I normally put my scribble files in a directory by themselves to make it easier to manually delete all the other files before committing, but a setting to put those files in something like a doc subdirectory would be very helpful.



____________________
Racket Users list:
http://lists.racket-lang.org/users

Matthew Flatt
2015-03-14 18:35:32 UTC
Permalink
Post by Jon Zeppieri
I've been looking at the .gitignore files in various racket packages,
and the ones I've seen don't ignore files generated by scribble (.html
.css, etc.). So what is the common practice for keeping those files
out of source control?
All generated documentation files go into a "doc" subdirectory, so
ignoring a "doc" directory is probably the right choice for
".gitignore".

Various Racket packages should probably include "doc" in ".gitignore".
The omission hasn't created problems, because the packages are
typically installed in installation scope, and documentation is
rendered to the installation's "doc" directory in that case.

____________________
Racket Users list:
http://lists.racket-lang.org/users
Loading...