search

ruricolist / serapeum

Utilities beyond Alexandria
MIT License
425 stars 42 forks source link

Make searpeum.docs usable outside of Serapeum. #78

Closed svetlyak40wt closed 3 years ago

svetlyak40wt commented 3 years ago

Now any other library can reuse Serapeum's API reference building approach by loading system "serapeum/docs" and calling:

(serapeum.docs:update-function-reference
    "REFERENCE.md"
    :my-system)
ruricolist commented 3 years ago

Merged, thanks!

Out of curiosity, do you have any particular projects in mind to use it with?

svetlyak40wt commented 3 years ago

I'm searching a library to use for documenting my own libraries. While doing this, I'm reviewing features and create small example projects which can be used as templates:

https://github.com/cl-doc-systems

Will add Spinneret/docs to this list now. Probably somebody will like its approach.

Also, I tweet about my reviews, to make other people aware of different ways to document their Common Lisp libraries.

Hope, this work will lead to a better documented CL libraries.

svetlyak40wt commented 3 years ago

By the way, I can help you to set up a Github Action to update reference automatically.

ruricolist commented 3 years ago

That does sound useful.

svetlyak40wt commented 3 years ago

Here is a pull with GH Action: https://github.com/ruricolist/serapeum/pull/79