freenode/#clasp - IRC Chatlog
Search
17:28:05
drmeister
I got staple server working but none of my packages show anything at all. I read the documentation but I'm still puzzled as to how to proceed.
17:29:34
Shinmera
Staple depends on ASDF systems, rather than packages for its automated documentation generation.
17:29:58
drmeister
Also, I'm puzzled as to what staple does and whether it matches what I need. I'd like to create a front page that describes cando and provides links to other pages that describe different aspects of it. There would then be links to packages and systems like I see staple does for some systems.
17:30:03
Shinmera
I'd have to put together an example to show how to use its advanced facilities to generate docs without a system.
17:30:28
drmeister
That would be very much appreciated. Just the tiniest example that gives me a starting point.
17:31:34
Shinmera
Sure. If you could tell me what confuses you about the documentation of Staple itself, that would be great too. I know it's hard to grasp.
17:32:47
drmeister
It describes the API but I couldn't get a sense of how to work with it in the way I described above.
17:33:17
drmeister
You know how you approach any new thing with a bundle of needs and wants and then you want to match that to what the thing actually does. I ran into trouble there.
17:33:48
Shinmera
Okey. The brief outline is: add a method to find-project for your project name, that builds a project instance and adds the required page instances to the project.
17:34:01
drmeister
I'm want to write good documentation as well - I'll keep in mind what I just said.
17:34:07
Shinmera
Yeah, it's just hard for me to replicate that because I already know. Hence wanting some feedback :)
17:34:57
drmeister
So I did that with the project - does that automatically create an HTML page for the project?
17:35:33
Shinmera
A project is a bundle of pages. Once you generate a project it'll generate the output files of the project's pages.
17:37:50
drmeister
Custom projects - that sounds like my thing. I have a cando-user ASDF system - but it's loaded already when I load staple. When I tried to (staple:generate :cando-user) but it was an empty page.
17:38:50
Shinmera
In that case you can (defmethod staple:packages ((_ (eql (asdf:find-system :cando-user)))) (mapcar #'find-package '("PACKAGE-1" "PACKAGE-2" ...)))
17:39:20
Shinmera
that should tell Staple what packages belong to that and generating it should pick that up
17:46:20
drmeister
I'd like to have a main page like your staple main page that says "Welcome to Cando" and explains that Cando is made up of a bunch of packages containing symbols that are function names and classes - followed by a list of a few key packages and then a link to the list of all packages.
17:47:55
Shinmera
One reason Staple by default requires a system is so that it can resolve related source files (packages won't tell me where their source is)
17:49:20
Shinmera
You can do something like placing the documentation description file relative to the source file that defines the Staple project, if that's fine with you.
17:51:15
drmeister
What is documentation description file? Is that the staple.ext.lisp file or is it a file I specify that describes the first documentation page?
17:52:26
Shinmera
staple.ext.lisp is a way to add customisations to staple that'll get automatically picked up if you build the system with that file at its root.
21:56:15
kpoeck
Hello, I tried the cando container from Dockerhub on my work pc and at first glance it worked fine.
21:57:07
kpoeck
If it like to create a docker container just with clasp, could I use the files in https://github.com/clasp-developers/clasp/blob/dev/tools/dockerfiles/?
21:57:17
kpoeck
e.g. https://github.com/clasp-developers/clasp/blob/dev/tools/dockerfiles/cando-build/Dockerfile