tynet-lichat/shirakumo - IRC Chatlog
Search
10:09:31
Lichatter ctvo4h5p
Posted a question here about staple the other day. Had to leave before I could follow up
10:10:13
Lichatter ctvo4h5p
I am happy to write a staple.ext.lisp. In it I have (defmethod staple:packages ((system (eql (asdf:find-system :small))))
(list (find-package :small)))
(defmethod staple:packages ((system (eql (asdf:find-system :small-dna))))
(list (find-package :small-dna)))
10:18:03
Lichatter ctvo4h5p
Ok, so if I have two .asd files, one with :small and one with :small-dna, and the staple.ext.lisp I provided, if I try to run (staple:generate :small) i get no such package errors.
10:18:16
Lichatter ctvo4h5p
How do you want the documentation to be generated, and how are you currently doing it.
10:22:27
Lichatter ctvo4h5p
I have a base system that i would like documentation for (it have some classes and some functions for linear algebra) Ideally i would like a section (core) with each of the file core uses to have its documentation in on a per file basis (not all exported symbols in core lumped). Then i have extensions (small-dna) that also have various files. I would like these things defined in files to be grouped here as well, ideally with one page (small-dna) and different sections for the things exported in different files that make up small-dna. Similarly I have other, non-dna extenstions that i would like to include this way
10:23:23
Lichatter ctvo4h5p
I want to add my own .md writeups as well so im fine with writing the .ext.lisp file
10:24:09
shinmera
Ok, so what you want is significantly different to what staple does by default. You're going to have to create your own PAGE instances manually to tell it what to do how.
10:28:04
shinmera
You'll have to override staple:find-project, cerate a staple:simple-project instance and push the appropraite page instances to it.
10:28:26
shinmera
I don't have the time to put together a more elaborate example right now I'm afraid
10:32:29
Lichatter ctvo4h5p
Even in the current setup why would staple not generate docs for small-dna.
10:33:02
Lichatter ctvo4h5p
those are my files. sorry if these are rookie questions, still getting used to packaging projects is cl
10:33:05
shinmera
because when you (staple:generate :small) it only looks at that system, and not also small-dna.
10:34:50
shinmera
if you want to include small-dna as a 'subsystem' you can also do (staple:generate :small :subsystems '(:small-dna))
10:38:18
Lichatter ctvo4h5p
Ok, should my staple.ext.lisp contain both (defmethod staple:packages ((system (eql (asdf:find-system :small))))
(list (find-package :small)))
(defmethod staple:packages ((system (eql (asdf:find-system :small-dna))))
(list (find-package :small-dna)))
10:38:47
shinmera
It shouldn't have to. At least if the package is named the same as the system, staple will always make the connection on its own.
10:41:12
Lichatter ctvo4h5p
When trying the :subsystem way i get #<STANDARD-GENERIC-FUNCTION ASDF/COMPONENT:COMPONENT-NAME (3)>
when called with arguments
(:SMALL-DNA).
10:41:57
Lichatter ctvo4h5p
when trying to do (staple:generate :small-dna) in removes /docs/index.html not docs/small-dna/index.html
10:46:27
Lichatter ctvo4h5p
(asdf:initialize-source-registry
'(:source-registry
(:tree "/home/dd/quicklisp/local-projects/small/")
:inherit-configuration))
10:48:10
Lichatter ctvo4h5p
Ah I misread your message. (staple:generate :small :subsystems (list (asdf:find-system :small-dna))) works but small-dna page has no content on it
10:55:45
shinmera
Sorry you're having these issues. I can't help you right now, I have other work I need to concentrate on.
10:57:13
Lichatter ctvo4h5p
No problem. I'll try the pages route. maybe i can get things working like that
15:15:04
Colleen
Shinmera: probably worth setting a topic on libera #shirakumo -- it's currently blank. Can't do it myself because no ops here and it's +t.
15:15:04
SAL9000
Shinmera: probably worth setting a topic on libera #shirakumo -- it's currently blank. Can't do it myself because no ops here and it's +t.