Be sure not to use the name "doc" for the document, but instead a name that is connected to the package (because all documents are rendered to the same place in installation scope). In other words, either make the document source "somepackage.scrbl" or use "somepackage" as the document name in the `scribblings` entry of "info.rkt" that refers to "doc.scrbl".
There is no problem having a "doc.html" or "somepackage.html" in the package's main directory. For the "built" package format, documentation is rendered into "doc/somepackage/index.html", while various CSS and JS files go in "doc/". That organization allows the package manager to move or patch the rendered documentation to fit into the local installation (so hyperlinks work, for example). But the package manager can just as well re-render the documentation from the ".scrbl" source. At Thu, 17 Sep 2015 18:23:13 -0400, Neil Van Dyke wrote: > I'm going to try to retool for the new package system by the end of the > weekend, and have a couple questions... > > What's the current preferred convention on what documentation-related > files are included in the package? And is that convention expected to > remain stable for a year or more? > > For example, are the following files and paths the ones I'll have for > most small packages, long-term: > > * info.rkt (the usual) > * somepackage.rkt (the full implementation with embedded docs, for my > packages) > * main.rkt (the PLaneT-like `require` wrapper for the package/collection) > * doc.scrbl (the complete documentation Scribble file generated from > embedded docs with a tool that is not included in the package) > * doc.html (the main HTML file for rendered Scribble file, not > including the Scribble-added CSS and JS files) > > Or (if you want to see the package/collection name in the paths): > > * somepackage/info.rkt > * somepackage/somepackage.rkt > * somepackage/main.rkt > * somepackage/doc.scrbl > * somepackage/doc.html > > Is it OK that there are no separate subdirectories for documentation or > anything? > > And what about the various Scribble-added CSS and JS files? > > Note that I will *not* have separate `-lib`, `-doc`, and `-test` packages. > > Thanks, > Neil V. > > -- > You received this message because you are subscribed to the Google Groups > "Racket Users" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to racket-users+unsubscr...@googlegroups.com. > For more options, visit https://groups.google.com/d/optout. -- You received this message because you are subscribed to the Google Groups "Racket Users" group. To unsubscribe from this group and stop receiving emails from it, send an email to racket-users+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/d/optout.
