making a new package ... making new docs for the same

[Thomas Lynch]

Here is the setup I am asking questions against, scroll down to see the questions

set up ------------------------------------------------------------------------
I have split my new package into three directories, like those I see in the distribution:

§lambda1:/home/deep> ls -1
...
liquid
liquid-doc
liquid-lib
...

I then copied over and modified the info.rkt file:

§lambda1:/home/deep/liquid> ls
info.rkt  LICENSE.txt

§lambda1:/home/deep/liquid> cat info.rkt

#lang info
(define collection 'multi)
(define deps '("liquid-lib"   "liquid-doc"))
(define implies '("liquid-lib"   "liquid-doc"))
(define pkg-desc "Framework for developing experimental deep web search engines.")
(define pkg-authors '(twlynch))

I placed my racket file in liquid-lib:

§lambda1:/home/deep> ls liquid-lib
compiled  examples  info.rkt  liquid

§lambda1:/home/deep>  cat liquid-lib/info.rkt

#lang info
(define collection 'multi)
(define deps `("scheme-lib"  "base" ))
(define pkge-desc "implementation (no documentation) part of \"liquid\"")
(define pkg-authors '(twlynch))

§lambda1:/home/deep> ls liquid-lib/liquid
compiled        dbi-dblp.rkt         ...

I placed the scribble files in liquid-doc:

§lambda1:/home/deep> ls liquid-doc
example.scrbl  info.rkt  LICENSE.txt  liquid

§lambda1:/home/deep> cat liquid-doc/info.rkt

#lang info

(define collection 'multi)
(define deps '("base"))
(define build-deps '("scheme-lib"
                     "racket-doc"
                     "syntax-color-doc"
                     "liquid-lib"
                     "scribble-lib"))

(define pkg-desc "documentation part of \"liquid\"")

(define pkg-authors '(twlynch))

§lambda1:/home/deep> ls liquid-doc/liquid/
compiled      http-server.scrbl  liquid.scrbl         realtime.scrbl
db-lib.scrbl  info.rkt         query-parser.scrbl  tokens.scrbl

§lambda1:/home/deep> cat liquid-doc/liquid/liquid.scrbl

#lang scribble/doc
@(require scribble/manual scribble/struct scribble/xref
          (for-label scheme/base
                     scheme/contract
                     liquid/db-lib
                     ))

@title{LIQUID -- Framework for Developing Deep Web Search Programs and Servers}

@author["Thomas Walker Lynch and Andrea Calì"]

@table-of-contents[]

@include-section{"db-lib.scrbl"}
@include-section{"http-server.scrbl"}
@include-section{"query-parser.scrbl"}
@include-section{"realtime.scrbl"}
@include-section{"tokens.scrbl"}

questions:-----------------------------------------------------------------------------------

1. when trying to make the new package locally.  .. so what is the proper way to handle the dependencies?  I don't know if I should run raco pkg install on the liquid-doc and liquid-lib directories first, but haven't done that because I want these to be auto loaded and not directly in the catalog.

§lambda1:/home/deep/liquid> raco pkg install
raco pkg install: missing dependencies;
 specify `--deps search-auto' to install them, or
 specify `--deps search-ask' to be asked about installing them
  for package: /home/deep/liquid/
  missing packages:
   liquid-lib
   liquid-doc

2. when trying to build the docs standalone .. so how can one do this?

§lambda1:/home/deep/liquid-doc/liquid> scribble --htmls liquid.scrb
default-load-handler: cannot open module file
  module path: #<path:/home/deep/liquid-doc/liquid/liquid.scrb>
  path: /home/deep/liquid-doc/liquid/liquid.scrb
  system error: No such file or directory; errno=2
  context...:
   standard-module-name-resolver
   /usr/share/racket/pkgs/scribble-lib/scribble/run.rkt: [running body]

[Alexander D. Knauth]

On Apr 16, 2015, at 11:16 PM, Thomas Lynch <thomas...@reasoningtechnology.com> wrote:

> questions:-----------------------------------------------------------------------------------
>
> 1. when trying to make the new package locally. .. so what is the proper way to handle the dependencies? I don't know if I should run raco pkg install on the liquid-doc and liquid-lib directories first, but haven't done that because I want these to be auto loaded and not directly in the catalog.
>
>
> §lambda1:/home/deep/liquid> raco pkg install
> raco pkg install: missing dependencies;
> specify `--deps search-auto' to install them, or
> specify `--deps search-ask' to be asked about installing them
> for package: /home/deep/liquid/
> missing packages:
> liquid-lib
> liquid-doc

I would install them manually, and then if you want, you can demote them to auto-installed afterwards.

> 2. when trying to build the docs standalone .. so how can one do this?
>
> §lambda1:/home/deep/liquid-doc/liquid> scribble --htmls liquid.scrb
> default-load-handler: cannot open module file
> module path: #<path:/home/deep/liquid-doc/liquid/liquid.scrb>
> path: /home/deep/liquid-doc/liquid/liquid.scrb
> system error: No such file or directory; errno=2
> context...:
> standard-module-name-resolver
> /usr/share/racket/pkgs/scribble-lib/scribble/run.rkt: [running body]

Typo, liquid.scrb instead of liquid.scrbl ?

[Thomas Lynch]

> 2. when trying to build the docs standalone .. so how can one do this?
>
> §lambda1:/home/deep/liquid-doc/liquid> scribble --htmls liquid.scrb

...

Typo, liquid.scrb instead of liquid.scrbl ?

Excuse me, grabbed the wrong part of the transcript, here is the error.

§lambda1:/home/deep/liquid-doc/liquid> scribble --htmls liquid.scrbl
liquid.scrbl:5:21: collection not found
  for module path: liquid/db-lib
  collection: "liquid"
  in collection directories:
   /home/lynch/.racket/6.1/collects
   /usr/share/racket/collects
   ... [146 additional linked and package directories]
  context...:
   show-collection-err
   standard-module-name-resolver
   standard-module-name-resolver
   /usr/share/racket/pkgs/scribble-lib/scribble/run.rkt:143:24
   /usr/share/racket/pkgs/scribble-lib/scribble/run.rkt: [running body]

[Alexander D. Knauth]

On Apr 17, 2015, at 5:17 AM, Thomas Lynch <thomas...@reasoningtechnology.com> wrote:

>>> 2. when trying to build the docs standalone .. so how can one do this?

> §lambda1:/home/deep/liquid-doc/liquid> scribble --htmls liquid.scrbl
> liquid.scrbl:5:21: collection not found
> for module path: liquid/db-lib
> collection: "liquid"
> in collection directories:
> /home/lynch/.racket/6.1/collects
> /usr/share/racket/collects
> ... [146 additional linked and package directories]
> context...:
> show-collection-err
> standard-module-name-resolver
> standard-module-name-resolver
> /usr/share/racket/pkgs/scribble-lib/scribble/run.rkt:143:24
> /usr/share/racket/pkgs/scribble-lib/scribble/run.rkt: [running body]

Did you install liquid-lib first? Does the liquid directory in the liquid-lib package include a file called db-lib.rkt?

[Thomas Lynch]

Yes, db-lib.rkt is there in the liquid-lib/liquid directory .. as is db-lib.scribl is here in the liquid-doc/liquid dir.   Here are the details:

raco setup: error: during making for <pkgs>/liquid-doc/liquid
raco setup:   liquid/liquid.scrbl:14:17: include-section: not a module path
raco setup:     at: "\"db-lib.scrbl\""
raco setup:     in: (include-section "\"db-lib.scrbl\"")
raco setup:     context...:
raco setup:      /usr/share/racket/pkgs/scribble-lib/scribble/base.rkt:118:0
raco setup:      try-next
raco setup:      /usr/share/racket/collects/syntax/wrap-modbeg.rkt:46:4
raco setup:      /usr/share/racket/collects/compiler/cm.rkt:309:0: compile-zo*
raco setup:      /usr/share/racket/collects/compiler/cm.rkt:519:26
raco setup:      /usr/share/racket/collects/compiler/cm.rkt:512:42
raco setup:      /usr/share/racket/collects/compiler/cm.rkt:477:0: maybe-compile-zo
raco setup:      /usr/share/racket/collects/compiler/cm.rkt:588:2: do-check
raco setup:      /usr/share/racket/collects/compiler/cm.rkt:670:4
raco setup:      /usr/share/racket/collects/setup/parallel-do.rkt:420:20: loop

§lambda1:/home/deep/liquid-doc> ls liquid
compiled      doc         info.rkt      query-parser.scrbl  tokens.scrbl
db-lib.scrbl  http-server.scrbl  liquid.scrbl  realtime.scrbl

And this is db-lib.scribl:

§lambda1:/home/deep> cat liquid-doc/liquid/db-lib.scrbl

#lang scribble/base
@title{db-lib}
@section{Introduction}
   db-lib is the cure for world wide mouse cookie shortages...

If I comment out the include section for db-lib, then the next include gives me the same error.  The file is also in that same directory.

[Matthew Flatt]

At Fri, 17 Apr 2015 06:30:35 -0700 (PDT), Thomas Lynch wrote:
> Yes, db-lib.rkt is there in the liquid-lib/liquid directory .. as is
> db-lib.scribl is here in the liquid-doc/liquid dir. Here are the details:
>
> raco setup: error: during making for <pkgs>/liquid-doc/liquid
> raco setup: liquid/liquid.scrbl:14:17: include-section: not a module path
> raco setup: at: "\"db-lib.scrbl\""
> raco setup: in: (include-section "\"db-lib.scrbl\"")

I wonder if you're written

@include-section{"db-lib.scrbl"}

instead of

@include-section{db-lib.scrbl}

or

@include-section["db-lib.scrbl"]

?


If you include the quote marks in {...}, then it's equivalent to

@(include-section "\"db-lib.scrbl\"")

which could be why it shows up that way in the error message.

The second and third forms above are both equivalent to

@(include-section "db-lib.scrbl")

[Thomas Lynch]

Yes Matt this is the mistake I made as one can see in the first post of this thread that has a cat of the liquid.scrbl file shows the quotes.  The worst part is it seems I was warned about this ..removed the quotes and all of the errors just evaporated like magic!  .. and I was wondering if I had a path variable wrong somewhere.

Thank you Matt, Alex!