kstuart has quit [Remote host closed the connection]
King_julian has quit [Ping timeout: 265 seconds]
mari-estel has joined #commonlisp
King_julian has joined #commonlisp
decweb has joined #commonlisp
mari-estel has quit [Quit: shitty system]
jadzi has joined #commonlisp
Th30n has quit [Quit: restarting]
Th30n has joined #commonlisp
mala has quit [Read error: Connection reset by peer]
malaclyps has joined #commonlisp
mgl_ has joined #commonlisp
mgl has quit [Ping timeout: 244 seconds]
dnhester26 has joined #commonlisp
Akbar-Birbal has left #commonlisp [#commonlisp]
King_julian has quit [Ping timeout: 265 seconds]
<dnhester26>
paulapatience: thanks, just took a look at both of them. They seem good document builders. What I like about tinaa is that wihtout writing anything, just a line of code, it produces extremely useful output (at least for me) which includes tables of contents, tables of symbols, and makes it really easy to explore related systems as both a user and a developer and the main functionality even if there are no docstrings
<dnhester26>
and it lists things limiting the full docstring so that I can quickly and easy get the big picture. to get the full docstring, we just have to click on any symbol
<dnhester26>
and it generates tables for different types of symbols
<dnhester26>
Do you know something which can generate views like that?
donleo has joined #commonlisp
random-nick has joined #commonlisp
Venoflux has quit [Ping timeout: 272 seconds]
<dnhester26>
Shinmera: with staple, as a user without having to modify staple itself, is it possible to create templates which can generate tables like those links? Is it possible to make a template which has a left pane table of contents with links to different systems or packages or sections of the document? That's basically what I would like to do, make a few templates that will generate automatically documentation for any system which will h
<dnhester26>
ave pages like those in tinaa and in addition a table of contents
<Shinmera>
"Yes"
random-nick has quit [Quit: quit]
<Shinmera>
It's in quotes because one of staple's points is that it is infinitely customisable. But as usual with things like that, the further you stray from the beaten path, the more legwork you'll have to do. I can't give you ready recipes to get what you want, since I haven't done it myself before.
<Shinmera>
You can have staple emit many pages with relatively arbitrary content, but it's not super easy to set it up to do that.
<Shinmera>
Looking at making that easier has been on my todo for years, but alas it hasn't yet been pressing enough for me to actually go do it
<dnhester26>
Ah ok, from what I see though you are getting all the symbols and figuring out what they are. Are the symbols in the staple docs all exported? are there functions to get all symbols or only exported symbols?
<Shinmera>
Yes. Yes.
<Shinmera>
see definition-wanted-p
<Shinmera>
I don't know why you would ever want to emit all symbols
<Shinmera>
but again, you can do everything
<dnhester26>
Great
<dnhester26>
To do this, do I basically have to make my own generate function to replace `(staple:generate :my-system)`? (I confess I've yet to navigate the source code, I am just coming from the docs)
<ixelp>
GitHub - Shinmera/staple: Common Lisp tool to compile documentation pages using an HTML template.
<paulapatience>
dnhester26: With mgl-pax it would be quite easy to generate a section containing all the symbols in your package with suitable links. Just loop over the symbols in your package and FORMAT a defsection string.
<paulapatience>
You can also postprocess the generated Markdown to do whatever you want. I do that to generate PDF via LaTeX via Pandoc.
<Shinmera>
You can do much the same in staple's template
cmack` is now known as cmack
X-Scale has quit [Ping timeout: 256 seconds]
<dnhester26>
Shinmera: just want to make sure I'm understanding the gamepad example: you are basically saying 1) no susbsystems (why is this necessary?) 2) the page-type of any cl-gamepad system should have :document-package gamepad-docs 3) all packages in org.shirakumo.fraf.gamepad should be documented as being in the cl-gamepad system. Is that correct?
<Shinmera>
I think there used to be another system for a visualizer that I didn't want pulled in. The subsystems method shouldn't be necessary anymore.
<Shinmera>
2) is almost correct, it's just *the* cl-gamepad system, not *any*.
King_julian has quit [Ping timeout: 264 seconds]
<Shinmera>
3) the packages method says it should only emit symbols for the cl-gamepad package (thus not its impl package)
Venoflux has joined #commonlisp
<Shinmera>
The custom package I make so that the text in the examples has the package local nickname defined.
<Shinmera>
*the code in the readme has the package local nickname
<Shinmera>
if you don't use plns or don't have code blocks in the readme that rigamarole isn't necessary
<dnhester26>
Thanks, so those changes are mostly custom inference. From the docs though I thought I would have to use custom projects in order to generate other pages, and a new template to make a left side panel ToC. https://github.com/Shinmera/staple?tab=readme-ov-file#customisation Did I misunderstand something?
<ixelp>
GitHub - Shinmera/staple: Common Lisp tool to compile documentation pages using an HTML template.
<Shinmera>
you can also customise the DOCUMENTS method to add additional pages
<Shinmera>
the projects just bypass inference entirely, which may or may not be easier to get what you want
<Shinmera>
if you want to go the custom project route, you just need a method on FIND-PROJECT for your system, which returns the project instance with all the pages and whatever you want.
<Shinmera>
does that make sense?
<Shinmera>
I'm having a tough time concentrating at the moment and have some sort of headache, otherwise I'd put an example together for you
taku has joined #commonlisp
mgl_ has quit [Ping timeout: 244 seconds]
taku has quit [Changing host]
taku has joined #commonlisp
mgl_ has joined #commonlisp
easye has quit [Ping timeout: 244 seconds]
<dnhester26>
Shinmera: thanks so much for the explanation. I think I got it. With documents I can add the additional pages. That solves the tables I want to add and the Table of Contents.
easye has joined #commonlisp
<dnhester26>
How should I go about making a sidebar with a table of contents? With a template?
<ixelp>
staple/default/default.ctml at master · Shinmera/staple · GitHub
<dnhester26>
How would I go about getting the list of sections in order to make the Table of Contents? Just see the template/source for simple-page to figure it out?
<Shinmera>
Yea I guess.
<dnhester26>
Thanks so much for the explanations
<Shinmera>
Sure. Again, sorry this kind of customisation isn't better documented at the moment.
<dnhester26>
great, thanks, will try to do it
<Shinmera>
I've wanted to have multiple pages and so on in my own stuff before, just haven't had the time.
<dnhester26>
on the contrary, thank you for the contribution!
<dnhester26>
I saw the docs generated by tinaa adn they were basically what I've wanted all this time, if I can make some automatic generator using staple that will produce a close enough output, mixed with the github actions and setup that you have, it should hopefully be trivial making great documentation for all CL systems out there
<dnhester26>
Even if it's one page, I think that having a left side panel with a ToC and some summary tables will go a great way to making it easier to digest as a user
<Shinmera>
yeah, I don't like side panels because of mobile view :/
<Shinmera>
guess I could make it float or not dependent on the device view
<dnhester26>
I have a responsive template I want to use
<dnhester26>
by the way, should I make this as my own separate project or would you be open to the possibility (no pressure to accept it though if it's not to your liking) of accepting a PR?
<Shinmera>
PRs are always a possibility and I wouldn't mind having other template options included at all
<dnhester26>
ok, just to know if I should clone or start a new project, that's why I asked. thanks
<dnhester26>
it's better than any progress I've made lol
<Shinmera>
well, helps when you know the entire ecosystem
<dnhester26>
I was trying to bring this together https://pure-css.github.io/layouts/email/ to have the possibility of multiple side panles, one with the overall ToC and a second one with a list of exported symbols of the current package using this lightweight css file 10kb https://pure-css.github.io/
<ixelp>
Email – Layout Examples – Pure
<dnhester26>
but honestly that looks great already
<Shinmera>
I suppose it could be even nicer still, if it like figured out the header level and added nesting to the toc, but eh
treflip has quit [Remote host closed the connection]
treflip has joined #commonlisp
<dnhester26>
Shinmera: i'm trying to generate the docs for staple and keep getting errors. First I added (staple:generate :staple :if-exists :overwrite) this :if-exists property, but now it's giving me errors saying a lot of files don't exist, is there a default generate function somewhere that I should be using?
varjag has quit [Quit: ERC 5.5.0.29.1 (IRC client for GNU Emacs 29.3)]
<dnhester26>
nevermind trying with :supersede now and it looks like it's working
<Bubblegumdrop>
hey dnhester26
varjag has joined #commonlisp
<dnhester26>
Bubblegumdrop: whats up?
<Bubblegumdrop>
lisp adventures
<dnhester26>
?
taku has joined #commonlisp
<Shinmera>
dnhester26: the :overwrite option to open is almost never useful
notzmv has joined #commonlisp
<dnhester26>
Thanks didn't know that, i didn't know those were options in the generate command though, should I add it to the options here? https://shinmera.github.io/staple/#how_to
<ixelp>
Staple
taku has quit [Ping timeout: 246 seconds]
pranav has joined #commonlisp
<dnhester26>
":if-exists :supersede can be added to overwrite any existing documentation" or somethihn like that?
<Shinmera>
it says it right there
<Shinmera>
> :if-exists What to do if the output file already exists (see open).
<dnhester26>
ah, I missed it, my bad.
<Bubblegumdrop>
dnhester26 It's okay to link to your stuff from my blog?
<dnhester26>
by the way, about the .lass file, does it have to be compiled or built before or does generate take care of that? I've been making changes and nothing is happening, I figured it may be the css file is not being produced anew. Sorry for the newbie questions if this is too basic, I just never used staple or lass before
random-nick has joined #commonlisp
<Shinmera>
it does not
<dnhester26>
Bubblegumdrop: sure, thanks, though this is all Shinmera haha
<Shinmera>
LASS ships a small .el file that auto-compiles the css file when I save in emacs
<dnhester26>
Ok, I have no clue what just happened. haha I thought it was part of the CL project. Ok, I will look up what lass is and emacs. I see the source code file generated has the css inline, but doens't include any changes I made
<dnhester26>
this basically adds the systems on the left side so that it's easier to switch between each system's docs
<dnhester26>
I think this makes it more usable (at least for me)
<Shinmera>
I see
<dnhester26>
I'm trying now to add on the bottom of the docs, in the packages section, a list of every symbol in that package
<dnhester26>
hahahaha
<dnhester26>
was that pun intended
<dnhester26>
?
<Shinmera>
What pun
<dnhester26>
hahahahaha
<dnhester26>
I sent you an image and then you said "i see" hahaha
zxcvz has quit [Client Quit]
<dnhester26>
nevermind
NotThatRPG has joined #commonlisp
dino_tutter has quit [Quit: Leaving]
<dnhester26>
by the way, what expression did you use to generate the docs? just generating the staple docs doing (staple:generate :staple :if-exists :supersede) creates a bunch of files that are untracked
<Shinmera>
does it? I used exactly that.
treflip has joined #commonlisp
varjag has quit [Quit: ERC 5.5.0.29.1 (IRC client for GNU Emacs 29.3)]
<dnhester26>
Hm, should I commit and push the generated files? it's mostly images it seems
mari-estel has quit [Ping timeout: 252 seconds]
alcor has quit [Remote host closed the connection]
alcor has joined #commonlisp
zxcvz has joined #commonlisp
jonatack has quit [Read error: Connection reset by peer]
zxcvz has quit [Client Quit]
cqst has joined #commonlisp
<dnhester26>
Shinmera: https://imgur.com/R8eRH7k now showing symbols for the package under each package in the ToC
zwr has quit [Read error: Connection reset by peer]
zwr has joined #commonlisp
kg7ski has joined #commonlisp
<dnhester26>
Shinmera: If i want to add docs, which of the readme files should I modify? .md?
<Shinmera>
add docs to what
<dnhester26>
to staple
<dnhester26>
By the way, how can I change the css file? here https://shinmera.github.io/staple/index.html#GENERIC-FUNCTION%20STAPLE%3AFORMAT-DOCUMENTATION is seems to say I need to create a custom page type "If you would prefer other documentation styles, you should add a method specialising on a custom page type, then use that page type in your project." and then I guess do seomthing like this https://shinmera.github.io/staple/index.html#custom
<dnhester26>
_pages ?
<ixelp>
Staple
<Shinmera>
README.md, the others are for other subsystems.
<dnhester26>
thanks for merging my PR to lass haha
<dnhester26>
ah ok, thanks
<Shinmera>
the template just slurps in the css file
<Shinmera>
so change the template
lucasta has joined #commonlisp
lucasta has quit [Remote host closed the connection]
jadzi has joined #commonlisp
lucasta has joined #commonlisp
lucasta has quit [Remote host closed the connection]
lucasta has joined #commonlisp
lucasta has quit [Remote host closed the connection]
<dnhester26>
ahh thanks
jadzi has quit [Ping timeout: 264 seconds]
mgl_ has quit [Ping timeout: 244 seconds]
Pixel_Outlaw has joined #commonlisp
<dnhester26>
Shinmera: just finished this basic version. I think it adds a lot, specially for the math project link you sent, this should be very helpful. I'll try to get the table pages going next time I have a chance
<dnhester26>
I just submitted a PR, no pressure to accept though. Thanks for all your help!
<Shinmera>
sure
luna-is-here_ has quit []
luna-is-here has joined #commonlisp
jonatack has joined #commonlisp
leeb has joined #commonlisp
leeb has quit [Quit: leaving]
luna-is-here has quit []
v88m has joined #commonlisp
taku has joined #commonlisp
cage has joined #commonlisp
cage has quit [Excess Flood]
luna-is-here has joined #commonlisp
taku has quit [Ping timeout: 248 seconds]
dino_tutter has joined #commonlisp
cage has joined #commonlisp
jadzi has joined #commonlisp
amb007 has quit [Read error: Connection reset by peer]
amb007 has joined #commonlisp
jonatack has quit [Ping timeout: 272 seconds]
jonatack has joined #commonlisp
amb007 has quit [Ping timeout: 245 seconds]
amb007 has joined #commonlisp
v88m has quit [Read error: Connection reset by peer]
v88m has joined #commonlisp
v88m has quit [Read error: Connection reset by peer]
mgl_ has joined #commonlisp
zxcvz has joined #commonlisp
zxcvz has quit [Client Quit]
v88m has joined #commonlisp
v88m has quit [Read error: Connection reset by peer]
mgl_ has quit [Ping timeout: 252 seconds]
v88m has joined #commonlisp
v88m has quit [Read error: Connection reset by peer]
<dnhester26>
Why is it showing up there by default?
<dnhester26>
I just used the github actions workflow to see what would come out by default
Artea has quit [Remote host closed the connection]
<dnhester26>
Hm, weird, I just noticed the "About" section there, that shouldn't be there either...
<dnhester26>
ahhh maybe because my readme is an org file? README.org?
v88m has joined #commonlisp
yvm has joined #commonlisp
v88m has quit [Read error: Connection reset by peer]
jon_atack has joined #commonlisp
jonatack has quit [Ping timeout: 252 seconds]
jonatack has joined #commonlisp
zxcvz has joined #commonlisp
jon_atack has quit [Ping timeout: 252 seconds]
zxcvz has quit [Client Quit]
semarie has quit [Ping timeout: 252 seconds]
v88m has joined #commonlisp
v88m has quit [Read error: Connection reset by peer]
amb007 has quit [Read error: Connection reset by peer]
amb007 has joined #commonlisp
amb007 has quit [Ping timeout: 260 seconds]
amb007 has joined #commonlisp
amb007 has quit [Read error: Connection reset by peer]
amb007 has joined #commonlisp
v88m has joined #commonlisp
v88m has quit [Read error: Connection reset by peer]
King_julian has joined #commonlisp
jonatack has quit [Read error: Connection reset by peer]
jonatack has joined #commonlisp
reb has joined #commonlisp
v88m has joined #commonlisp
Akbar-Birbal has left #commonlisp [#commonlisp]
jmiven has quit [Quit: reboot]
mgl_ has joined #commonlisp
jmiven has joined #commonlisp
v88m has quit [Read error: Connection reset by peer]
tam has joined #commonlisp
yvm has quit [Quit: Leaving]
<dnhester26>
oh my gosh: i feel blocked by something really dumb. can anyone please explain how to get a sha256 hash for a string given a key? I've been trying to fight with irconclad, I'm missing something
jonatack has quit [Ping timeout: 260 seconds]
jonatack has joined #commonlisp
v88m has joined #commonlisp
v88m has quit [Read error: Connection reset by peer]
jadzi has quit [Ping timeout: 248 seconds]
v88m has joined #commonlisp
mwnaylor has joined #commonlisp
v88m has quit [Read error: Connection reset by peer]